DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomic Medicine Service Alliance - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Data Type Profile: Correlation Identifier

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

EI - Entity Identifier

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

CX - Extended Composite ID with Check Digit

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

Usages:

• Derived from this DataType Profile: Accession Number, Episode Number, Filler Order Number, Genomics Pedigree Number... Show 3 more, Medical Record Number, Placer Group Number and Placer Order Number
• Use this DataType Profile: Diagnostic Report, DocumentReference, Encounter, Observation Diagnostic Implication... Show 4 more, Observation Variant, Observation, ServiceRequest and Specimen

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier	An identifier intended for computation
type	S	0..1	CodeableConcept	Description of identifier Binding: NW IdentifierType (required)
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

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Identifier.type	required	NWIdentifierType https://nw-gmsa.github.io/ValueSet/NWIdentifierType From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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	SΣ	0..1	CodeableConcept	Description of identifier Binding: NW IdentifierType (required)
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
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
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if 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 Example General: 123456
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	required	NWIdentifierType https://nw-gmsa.github.io/ValueSet/NWIdentifierType From this IG
Identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: NW IdentifierType (required)
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

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	required	NWIdentifierType https://nw-gmsa.github.io/ValueSet/NWIdentifierType From this IG
Identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.assigner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 6 elements
Must-Support: 7 elements

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	Identifier	An identifier intended for computation
type	S	0..1	CodeableConcept	Description of identifier Binding: NW IdentifierType (required)
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

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Identifier.type	required	NWIdentifierType https://nw-gmsa.github.io/ValueSet/NWIdentifierType From this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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	SΣ	0..1	CodeableConcept	Description of identifier Binding: NW IdentifierType (required)
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
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
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if 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 Example General: 123456
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	required	NWIdentifierType https://nw-gmsa.github.io/ValueSet/NWIdentifierType From this IG
Identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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: NW IdentifierType (required)
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

Terminology Bindings

Path	Conformance	ValueSet	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	required	NWIdentifierType https://nw-gmsa.github.io/ValueSet/NWIdentifierType From this IG
Identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.assigner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 6 elements
Must-Support: 7 elements

Other representations of profile: CSV, Excel, Schematron