DRAFT Implementation Guide

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

NHS England North West GMSA - IHE Laboratory Testing Workflow (LTW) - 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: NHS Number

Only traced NHS Number SHOULD be used, un-traced NHS Numbers MUST be clearly indicated.

Format: NNNNNNNNNN (400 000 000 to 499 999 999, and 600 000 000 to 799 999)

Usage:

• Use this DataType Constraint: Diagnostic Report, DocumentReference, Encounter, Observation... Show 2 more, Patient and ServiceRequest

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
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 Required Pattern: https://fhir.nhs.uk/Id/nhs-number
value		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	Σ	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 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 ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.nhs.uk/Id/nhs-number
value	Σ	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Fixed Value: NH http://hl7.org/fhir/ValueSet/identifier-type from 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	Σ	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 Required Pattern: https://fhir.nhs.uk/Id/nhs-number
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)	Organization that issued id (may be just text)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Fixed Value: NH http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

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 Required Pattern: https://fhir.nhs.uk/Id/nhs-number
value		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	Σ	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 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 ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.nhs.uk/Id/nhs-number
value	Σ	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

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Fixed Value: NH http://hl7.org/fhir/ValueSet/identifier-type from 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	Σ	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 Required Pattern: https://fhir.nhs.uk/Id/nhs-number
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)	Organization that issued id (may be just text)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Identifier.type	extensible	Fixed Value: NH http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

This structure is derived from Identifier

Summary

Mandatory: 2 elements
Fixed: 1 element

Other representations of profile: CSV, Excel, Schematron