Shared Health Specification and Guide Version 5.0

 

The official URL for this profile is:

http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier-person

Download Excel representation

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

>

This structure is derived from Shared Health Identifier

NameCard.TypeConstraints and Usage
.  Identifier 0..*Shared Health IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  type 1..1CodeableConceptBinding: SharedIdentifierType (20190415) (extensible)
Definition:
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.


Comments:
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

...  coding 0..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

...  text 0..1stringDefinition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Very often the text is the same as a displayName of one of the codings.

..  system 1..1uriExample' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.

..  value 1..1stringExample' General': 123456
Example' ???': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

This structure is derived from Shared Health Identifier

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 7 elements

This structure is derived from Shared Health Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... type S1..1CodeableConceptDescription of identifier
Binding: SharedIdentifierType (20190415) (extensible)
.... coding S0..*CodingCode defined by a terminology system
..... system S1..1uriIdentity of the terminology system
..... code S1..1codeSymbol in syntax defined by the system
.... text S0..1stringPlain text representation of the concept
... system S1..1uriThe namespace for the identifier
... value S1..1stringThe value that is unique
Example ???: 123456

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type SΣ1..1CodeableConceptDescription of identifier
Binding: SharedIdentifierType (20190415) (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ0..*CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringPlain text representation of the concept
... system SΣ1..1uriThe namespace for the identifier
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
... value SΣ1..1stringThe value that is unique
Example General: 123456
Example ???: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Grid View

This structure is derived from Shared Health Identifier

NameCard.TypeConstraints and Usage
.  Identifier 0..*Shared Health IdentifierDefinition:
A technical identifier - identifies some entity uniquely and unambiguously.

..  type 1..1CodeableConceptBinding: SharedIdentifierType (20190415) (extensible)
Definition:
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.


Comments:
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

...  coding 0..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

...  text 0..1stringDefinition:
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.


Comments:
Very often the text is the same as a displayName of one of the codings.

..  system 1..1uriExample' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
Definition:
Establishes the namespace in which set of possible id values is unique.

..  value 1..1stringExample' General': 123456
Example' ???': 123456
Definition:
The portion of the identifier typically relevant to the user and which is unique within the context of the system.


Comments:
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

This structure is derived from Shared Health Identifier

Summary

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 7 elements

Differential View

This structure is derived from Shared Health Identifier

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... type S1..1CodeableConceptDescription of identifier
Binding: SharedIdentifierType (20190415) (extensible)
.... coding S0..*CodingCode defined by a terminology system
..... system S1..1uriIdentity of the terminology system
..... code S1..1codeSymbol in syntax defined by the system
.... text S0..1stringPlain text representation of the concept
... system S1..1uriThe namespace for the identifier
... value S1..1stringThe value that is unique
Example ???: 123456

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Identifier 0..*Shared Health IdentifierAn identifier intended for computation
... id 0..1idxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

... type SΣ1..1CodeableConceptDescription of identifier
Binding: SharedIdentifierType (20190415) (extensible)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ0..*CodingCode defined by a terminology system
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... system SΣ1..1uriIdentity of the terminology system
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text SΣ0..1stringPlain text representation of the concept
... system SΣ1..1uriThe namespace for the identifier
Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
... value SΣ1..1stringThe value that is unique
Example General: 123456
Example ???: 123456
... period Σ0..1PeriodTime period when id is/was valid for use
... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Identifier.userequiredIdentifierUse
Identifier.typeextensibleSharedIdentifierType

Constraints

IdPathDetailsRequirements