Virtually Healthcare HL7 FHIR Implementation Guide
0.1.0-current - ci-build United Kingdom flag

Virtually Healthcare HL7 FHIR 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/Virtually-Healthcare-FHIR-Implementation-Guide/ and changes regularly. See the Directory of published versions

Data Type Profile: Common Resource Identifiers

Official URL: https://fhir.virtually.healthcare/StructureDefinition/CommonResourceIdentifiers Version: 0.1.0-current
Draft as of 2024-11-06 Computable Name: CommonResourceIdentifiers

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:

Formal Views of Profile Content

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

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... system 1..1 uri The namespace for the identifier value
Binding: UK Common Resource Identifiers (required)
... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.systemrequiredCommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers)
https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 (required)
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.systemrequiredCommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers)
https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 (required)
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredCommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers)
https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers
from this IG
Identifier.assigner.typeextensibleResourceType
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:

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier Identifier
... system 1..1 uri The namespace for the identifier value
Binding: UK Common Resource Identifiers (required)
... 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Identifier.systemrequiredCommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers)
https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 (required)
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.systemrequiredCommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers)
https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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 (required)
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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Identifier.systemrequiredCommonResourceIdentifiers (a valid code from UKCommonResourceIdentifiers)
https://fhir.virtually.healthcare/ValueSet/UKCommonResourceIdentifiers
from this IG
Identifier.assigner.typeextensibleResourceType
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:

 

Other representations of profile: CSV, Excel, Schematron