Virtually Healthcare HL7 FHIR R4 Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/HL7-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Data Type Profile: Common Resource Identifiers

Common Resource Identifiers

This is aimed at being HL7 v2 compatible, in particular HL7 v2 OBX and HL7 FHIR Observation, see Segment OBX to Observation Map for detailed mapping.

Usage:

• Use this DataType Constraint: AllergyIntolerance, Condition, DiagnosticReport, DocumentReference... Show 5 more, Immunization, MedicationRequest, Observation, QuestionnaireResponse and ServiceRequest

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier			Identifier
system		1..1	uri	The namespace for the identifier value Binding: UK Common Resource Identifiers (extensible)
value		1..1	string	The value that is unique
assigner		0..1	Reference(Organization)	Populate if the identifier.value is reused by multiple providers (as is the case with UUID and EMIS identifiers)
identifier		0..1	OrganisationCode	An identifier intended for computation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Identifier.system	extensible	CommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers) https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers from this IG

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	An identifier intended for computation
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Binding: UK Common Resource Identifiers (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Populate if the identifier.value is reused by multiple providers (as is the case with UUID and EMIS identifiers)
identifier		0..1	OrganisationCode	An identifier intended for computation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.system	extensible	CommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers) https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers from this IG

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	An identifier intended for computation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Binding: UK Common Resource Identifiers (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Populate if the identifier.value is reused by multiple providers (as is the case with UUID and EMIS identifiers)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier		0..1	OrganisationCode	An identifier intended for computation
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Identifier.system	extensible	CommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers) https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers from this IG
Identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• Organisation Code (https://fhir.virtually.healthcare/StructureDefinition/organisation-code)

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints
Identifier			Identifier
system		1..1	uri	The namespace for the identifier value Binding: UK Common Resource Identifiers (extensible)
value		1..1	string	The value that is unique
assigner		0..1	Reference(Organization)	Populate if the identifier.value is reused by multiple providers (as is the case with UUID and EMIS identifiers)
identifier		0..1	OrganisationCode	An identifier intended for computation
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Identifier.system	extensible	CommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers) https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	An identifier intended for computation
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Binding: UK Common Resource Identifiers (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	Populate if the identifier.value is reused by multiple providers (as is the case with UUID and EMIS identifiers)
identifier		0..1	OrganisationCode	An identifier intended for computation
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.system	extensible	CommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers) https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Identifier		0..*	Identifier	An identifier intended for computation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Binding: UK Common Resource Identifiers (extensible) Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Populate if the identifier.value is reused by multiple providers (as is the case with UUID and EMIS identifiers)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier		0..1	OrganisationCode	An identifier intended for computation
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Identifier.system	extensible	CommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers) https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers from this IG
Identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• Organisation Code (https://fhir.virtually.healthcare/StructureDefinition/organisation-code)

Other representations of profile: CSV, Excel, Schematron