NHS North West Genomics, published by NHS North West Genomics. This guide is not an authorized publication; it is the continuous build for version 2.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/nw-gmsa.github.com/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Data Type Profile: NHS Identifier

Patient Administration HL7 IdentifierType: NH National Health Plan Identifier NHS Data Model and Dictionary England/Wales NHS NUMBER, Northern Ireland HEALTH AND CARE NUMBER and Scotland COMMUNITY HEALTH INDEX NUMBER Only traced NHS Number SHOULD be used, un-traced NHS Numbers MUST be clearly indicated.

Usages:

• Use this DataType Profile: AuditEvent, Composition Genomic Report, Condition, Diagnostic Report... Show 10 more, DocumentReference, Encounter, Event Notification (MessageHeader), Observation, Patient, Procedure, QuestionnaireResponse, RelatedPerson, ServiceRequest and Task

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	CorrelationIdentifier	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) 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	SΣ	1..1	uri	Recommended. This may be defined by a EPR/LIMS system. Binding: UK National Health Identifiers (required) 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Σ	0..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 Example Manchester University NHS Foundation Trust: R0A
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	required	NW IdentifierType	📦2.0.3	This IG
Identifier.system	Base	required	UK National Health Identifiers	📦2.0.3	This IG
Identifier.assigner.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

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

This structure is derived from CorrelationIdentifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier			CorrelationIdentifier
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	Recommended. This may be defined by a EPR/LIMS system. Binding: UK National Health Identifiers (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Identifier.system	Base	required	UK National Health Identifiers	📦2.0.3	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	CorrelationIdentifier	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) 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	SΣ	1..1	uri	Recommended. This may be defined by a EPR/LIMS system. Binding: UK National Health Identifiers (required) 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Σ	0..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 Example Manchester University NHS Foundation Trust: R0A
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	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	required	NW IdentifierType	📦2.0.3	This IG
Identifier.system	Base	required	UK National Health Identifiers	📦2.0.3	This IG
Identifier.assigner.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Identifier.assigner.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.assigner.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 CorrelationIdentifier

Summary

Mandatory: 1 element
Fixed: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	CorrelationIdentifier	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) 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	SΣ	1..1	uri	Recommended. This may be defined by a EPR/LIMS system. Binding: UK National Health Identifiers (required) 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Σ	0..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 Example Manchester University NHS Foundation Trust: R0A
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	required	NW IdentifierType	📦2.0.3	This IG
Identifier.system	Base	required	UK National Health Identifiers	📦2.0.3	This IG
Identifier.assigner.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

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

Differential View

This structure is derived from CorrelationIdentifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier			CorrelationIdentifier
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	Recommended. This may be defined by a EPR/LIMS system. Binding: UK National Health Identifiers (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Identifier.system	Base	required	UK National Health Identifiers	📦2.0.3	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier		0..*	CorrelationIdentifier	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) 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	SΣ	1..1	uri	Recommended. This may be defined by a EPR/LIMS system. Binding: UK National Health Identifiers (required) 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Σ	0..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 Example Manchester University NHS Foundation Trust: R0A
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	Status	Usage	ValueSet	Version	Source
Identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.type	Base	required	NW IdentifierType	📦2.0.3	This IG
Identifier.system	Base	required	UK National Health Identifiers	📦2.0.3	This IG
Identifier.assigner.​type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Identifier.assigner.​identifier.use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Identifier.assigner.​identifier.type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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 CorrelationIdentifier

Summary

Mandatory: 1 element
Fixed: 1 element

Other representations of profile: CSV, Excel, Schematron