North West Genomics Testing Workflow (GTW)
0.0.1 - ci-build
North West Genomics Testing Workflow (GTW)
0.0.1 - ci-build
DRAFT Implementation Guide
This is for collaboration and discussion purposes and is subject to change.
North West Genomics Testing Workflow (GTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://hl7.mft.nhs.uk/StructureDefinition/CorrelationIdentifier | Version: 0.0.1 | |||
| Draft as of 2025-02-22 | Computable Name: CorrelationIdentifier | |||
See Enterprise Integration Patterns - Correlation Identifier and Rule 3: Reference Other Aggregates by Identity (Implementing Domain Driven Design)
This relates directly to HL7 v2 Data Types
The EI.2 - Namespace Id (FHIR Identifier.assigner.value) should be an ODS code. E.g. ORC segment (extract)
ORC|RE|ABC123^ROA|XYZ789^699X0
where ROA is the ODS code for Manchester University NHS Foundation Trust and 699XO is the ODS code from NW Region GLH
The ‘CX.6 - Assigning Facility’ (FHIR Identifier.assigner.value) should be an ODS code. E.g. ORC segment (extract)
PID|1||EPI1234^^^MR^ROA||Doe^John^Michael^Mr.||19800101|123 Main St^Anytown^CA^12345||555-1234||S||ABC123|987654321|M
where ROA is the ODS code for Manchester University NHS Foundation Trust
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 |
0..* | Identifier | An identifier intended for computation | |
 type |
S | 0..1 | CodeableConcept | Description of identifier |
| system |
S | 1..1 | uri | uri is defined by supplying organisation. |
| value |
S | 1..1 | string | The value MUST be unique to the organisation |
 assigner |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
 identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code |
| value |
S | 1..1 | string | The value that is unique |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation ele-1: All FHIR elements must have a @value or children | |
 use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
 type |
SΣ | 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. ele-1: All FHIR elements must have a @value or children |
| system |
SΣ | 1..1 | uri | uri is defined by supplying organisation. ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value MUST be unique to the organisation ele-1: All FHIR elements must have a @value or children Example General: 123456 |
 assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.assigner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard |
| 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 |
SΣ | 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 |
SΣ | 1..1 | uri | uri is defined by supplying organisation. Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value MUST be unique to the organisation Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| 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 |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
 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 |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code |
| value |
SΣ | 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) | Organization that issued id (may be just text) |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Identifier.assigner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.assigner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
This structure is derived from Identifier
Differential View
This structure is derived from Identifier
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation | |
| type |
S | 0..1 | CodeableConcept | Description of identifier |
| system |
S | 1..1 | uri | uri is defined by supplying organisation. |
| value |
S | 1..1 | string | The value MUST be unique to the organisation |
| assigner |
S | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| system |
S | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code |
| value |
S | 1..1 | string | The value that is unique |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Identifier |
0..* | Identifier | An identifier intended for computation ele-1: All FHIR elements must have a @value or children | |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| type |
SΣ | 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. ele-1: All FHIR elements must have a @value or children |
| system |
SΣ | 1..1 | uri | uri is defined by supplying organisation. ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value MUST be unique to the organisation ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code |
| value |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.assigner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard |
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 |
SΣ | 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 |
SΣ | 1..1 | uri | uri is defined by supplying organisation. Example General: http://www.acme.com/identifiers/patient |
| value |
SΣ | 1..1 | string | The value MUST be unique to the organisation Example General: 123456 |
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner |
SΣ | 1..1 | Reference(Organization) | Organization that issued id (may be just text) |
| 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 |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| 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 |
SΣ | 1..1 | uri | The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code |
| value |
SΣ | 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) | Organization that issued id (may be just text) |
| display |
Σ | 0..1 | string | Text alternative for the resource |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard | |
| Identifier.assigner.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | |
| Identifier.assigner.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1from the FHIR Standard | |
| Identifier.assigner.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typefrom the FHIR Standard |
This structure is derived from Identifier
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ Manchester University NHS Foundation Trust. Package nhs.mft.fhir#0.0.1 based on FHIR 4.0.1. Generated 2025-02-22
Links: Table of Contents |
QA Report
| New Issue | Issues
Version History |
|
Propose a change