Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
Virtually Healthcare HL7 FHIR R4 Implementation Guide
0.1.0-current - ci-build
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
| Official URL: https://fhir.virtually.healthcare/StructureDefinition/nhs-numbers | Version: 0.1.0-current | |||
| Draft as of 2024-12-02 | Computable Name: NHSNumbers | |||
NHS Data Dictionary: NHS NUMBER, COMMUNITY HEALTH INDEX NUMBER and HEALTH AND CARE NUMBER
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Identifier |
Identifier | |||
 type |
0..1 | CodeableConcept | Description of identifier Fixed Value: As shown (National Health Plan Identifier) | |
   coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NH | |
| system |
1..1 | uri | The namespace for the identifier value Binding: UK National Insurance Identifiers (required) | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | Reference(Organization) | Assigning organisation, populate if known (i.e. X24/X26 for NHS England) | |
 identifier |
0..1 | OrganisationCode | An identifier intended for computation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.system | required | UKNationalIdentifiers (a valid code from UKNationalIdentifier)https://fhir.virtually.healthcare/ValueSet/UKNationalIdentifiersfrom 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 . |
| 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. Fixed Value: As shown (National Health Plan Identifier) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NH | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Binding: UK National Insurance 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) | Assigning organisation, populate if known (i.e. X24/X26 for NHS England) |
| identifier |
0..1 | OrganisationCode | An identifier intended for computation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Fixed Value: NHhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.system | required | UKNationalIdentifiers (a valid code from UKNationalIdentifier)https://fhir.virtually.healthcare/ValueSet/UKNationalIdentifiersfrom 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. Fixed Value: As shown (National Health Plan Identifier) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NH | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Binding: UK National Insurance 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) | Assigning organisation, populate if known (i.e. X24/X26 for NHS England) |
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Fixed Value: NHhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.system | required | UKNationalIdentifiers (a valid code from UKNationalIdentifier)https://fhir.virtually.healthcare/ValueSet/UKNationalIdentifiersfrom this IG | |
| Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
Identifier | |||
| type |
0..1 | CodeableConcept | Description of identifier Fixed Value: As shown (National Health Plan Identifier) | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NH | |
| system |
1..1 | uri | The namespace for the identifier value Binding: UK National Insurance Identifiers (required) | |
| value |
1..1 | string | The value that is unique | |
| assigner |
0..1 | Reference(Organization) | Assigning organisation, populate if known (i.e. X24/X26 for NHS England) | |
| identifier |
0..1 | OrganisationCode | An identifier intended for computation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.system | required | UKNationalIdentifiers (a valid code from UKNationalIdentifier)https://fhir.virtually.healthcare/ValueSet/UKNationalIdentifiersfrom 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 . |
| 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. Fixed Value: As shown (National Health Plan Identifier) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NH | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Binding: UK National Insurance 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) | Assigning organisation, populate if known (i.e. X24/X26 for NHS England) |
| identifier |
0..1 | OrganisationCode | An identifier intended for computation | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Fixed Value: NHhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.system | required | UKNationalIdentifiers (a valid code from UKNationalIdentifier)https://fhir.virtually.healthcare/ValueSet/UKNationalIdentifiersfrom 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. Fixed Value: As shown (National Health Plan Identifier) |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| coding |
1..1 | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| id |
0..0 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| version |
0..0 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: NH | |
| display |
0..0 | string | Representation defined by the system | |
| userSelected |
0..0 | boolean | If this coding was chosen directly by the user | |
| text |
0..0 | string | Plain text representation of the concept | |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Binding: UK National Insurance 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) | Assigning organisation, populate if known (i.e. X24/X26 for NHS England) |
| 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 | ||||
| Path | Conformance | ValueSet / Code | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Fixed Value: NHhttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.system | required | UKNationalIdentifiers (a valid code from UKNationalIdentifier)https://fhir.virtually.healthcare/ValueSet/UKNationalIdentifiersfrom this IG | |
| Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron