3.57 StructureDefinition: Shared Health Person Identifier
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier-person
3.57.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Shared Health Identifier
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Identifier | 0..* | Shared Health Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
 type | 1..1 | CodeableConcept | Binding: 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..* | Coding | Definition: 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..1 | uri | Definition: 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..1 | code | Definition: 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..1 | string | Definition: 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..1 | uri | Example' 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..1 | string | Example' 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
This structure is derived from Shared Health Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
| type | S | 1..1 | CodeableConcept | Description of identifier Binding: SharedIdentifierType (20190415) (extensible) |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system |
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| text | S | 0..1 | string | Plain text representation of the concept |
| system | S | 1..1 | uri | The namespace for the identifier |
| value | S | 1..1 | string | The value that is unique Example ???: 123456 |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: SharedIdentifierType (20190415) (extensible) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 1..1 | uri | The 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..1 | string | The value that is unique Example General: 123456 Example ???: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Grid View
This structure is derived from Shared Health Identifier
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Identifier | 0..* | Shared Health Identifier | Definition: A technical identifier - identifies some entity uniquely and unambiguously. |
| type | 1..1 | CodeableConcept | Binding: 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..* | Coding | Definition: 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..1 | uri | Definition: 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..1 | code | Definition: 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..1 | string | Definition: 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..1 | uri | Example' 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..1 | string | Example' 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
Differential View
This structure is derived from Shared Health Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
| type | S | 1..1 | CodeableConcept | Description of identifier Binding: SharedIdentifierType (20190415) (extensible) |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system |
| code | S | 1..1 | code | Symbol in syntax defined by the system |
| text | S | 0..1 | string | Plain text representation of the concept |
| system | S | 1..1 | uri | The namespace for the identifier |
| value | S | 1..1 | string | The value that is unique Example ???: 123456 |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier | 0..* | Shared Health Identifier | An identifier intended for computation | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: SharedIdentifierType (20190415) (extensible) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 1..1 | uri | The 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..1 | string | The value that is unique Example General: 123456 Example ???: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.57.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Identifier.use | required | IdentifierUse |
| Identifier.type | extensible | SharedIdentifierType |
3.57.4 Constraints
Constraints
| Id | Path | Details | Requirements |