ExampleIG, published by Example Publisher. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/trifork/fhir-ig-sample/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Data Type Profile: UID Identifier

Unique IDentifier

Usages:

• Use this DataType Profile: Practitioner

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	C	0..*	Identifier	An identifier intended for computation Constraints: UIDValueInvariant, UIDPrefixMatches
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:prefix		1..1	string	Prefix URL: http://example.org/StructureDefinition/Prefix
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://example.org/uid
value	Σ	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

Constraints

Id	Grade	Path(s)	Details	Requirements
UIDPrefixMatches	error	Identifier	The prefix (before the ':') must match the PrefixExtension value. : value.startsWith(%context.extension.where(url='http://example.org/StructureDefinition/Prefix').first().value & ':')
UIDValueInvariant	error	Identifier	Validation logic for the value element. : value.matches('^[A-z0-9]+:[a-z0-9\\.-]+$')
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	An identifier intended for computation Constraints: UIDValueInvariant, UIDPrefixMatches
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:prefix		1..1	string	Prefix URL: http://example.org/StructureDefinition/Prefix
system		1..1	uri	The namespace for the identifier value Fixed Value: http://example.org/uid
value		1..1	string	The value that is unique
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
UIDPrefixMatches	error	Identifier	The prefix (before the ':') must match the PrefixExtension value. : value.startsWith(%context.extension.where(url='http://example.org/StructureDefinition/Prefix').first().value & ':')
UIDValueInvariant	error	Identifier	Validation logic for the value element. : value.matches('^[A-z0-9]+:[a-z0-9\\.-]+$')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	An identifier intended for computation Constraints: UIDValueInvariant, UIDPrefixMatches
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:prefix		1..1	string	Prefix URL: http://example.org/StructureDefinition/Prefix
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://example.org/uid
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	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
UIDPrefixMatches	error	Identifier	The prefix (before the ':') must match the PrefixExtension value. : value.startsWith(%context.extension.where(url='http://example.org/StructureDefinition/Prefix').first().value & ':')
UIDValueInvariant	error	Identifier	Validation logic for the value element. : value.matches('^[A-z0-9]+:[a-z0-9\\.-]+$')
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: 4 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

• http://example.org/StructureDefinition/Prefix

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	An identifier intended for computation Constraints: UIDValueInvariant, UIDPrefixMatches
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:prefix		1..1	string	Prefix URL: http://example.org/StructureDefinition/Prefix
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://example.org/uid
value	Σ	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

Constraints

Id	Grade	Path(s)	Details	Requirements
UIDPrefixMatches	error	Identifier	The prefix (before the ':') must match the PrefixExtension value. : value.startsWith(%context.extension.where(url='http://example.org/StructureDefinition/Prefix').first().value & ':')
UIDValueInvariant	error	Identifier	Validation logic for the value element. : value.matches('^[A-z0-9]+:[a-z0-9\\.-]+$')
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()

Differential View

This structure is derived from Identifier

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	An identifier intended for computation Constraints: UIDValueInvariant, UIDPrefixMatches
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:prefix		1..1	string	Prefix URL: http://example.org/StructureDefinition/Prefix
system		1..1	uri	The namespace for the identifier value Fixed Value: http://example.org/uid
value		1..1	string	The value that is unique
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
UIDPrefixMatches	error	Identifier	The prefix (before the ':') must match the PrefixExtension value. : value.startsWith(%context.extension.where(url='http://example.org/StructureDefinition/Prefix').first().value & ':')
UIDValueInvariant	error	Identifier	Validation logic for the value element. : value.matches('^[A-z0-9]+:[a-z0-9\\.-]+$')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Identifier	C	0..*	Identifier	An identifier intended for computation Constraints: UIDValueInvariant, UIDPrefixMatches
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:prefix		1..1	string	Prefix URL: http://example.org/StructureDefinition/Prefix
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	Σ	1..1	uri	The namespace for the identifier value Fixed Value: http://example.org/uid
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	URI
Identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
UIDPrefixMatches	error	Identifier	The prefix (before the ':') must match the PrefixExtension value. : value.startsWith(%context.extension.where(url='http://example.org/StructureDefinition/Prefix').first().value & ':')
UIDValueInvariant	error	Identifier	Validation logic for the value element. : value.matches('^[A-z0-9]+:[a-z0-9\\.-]+$')
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: 4 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

• http://example.org/StructureDefinition/Prefix

Other representations of profile: CSV, Excel, Schematron