EU Imaging Report R5
1.0.0-ballot - ci-build 150

EU Imaging Report R5, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r5/ and changes regularly. See the Directory of published versions

Data Type Profile: Identifier: SOP Instance UID

Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/SopInstanceUidIdentifierEuImaging Version: 1.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: SopInstanceUidIdentifierEuImaging

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

This profile on Identifier represents the SOP Instance UID (0008,0018) for the Imaging Order.

One or more DICOM identifier codes used by this profile come from the temporary MissingDicomTerminology CodeSystem and must be replaced with the equivalents defined by the DICOM terminology IG once it is published.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier C 0..* Identifier An identifier intended for computation
Constraints: ident-1
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
Identifier.type.id 0..1 string Unique id for inter-element referencing
Identifier.type.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Identifier.type.coding.id 0..1 string Unique id for inter-element referencing
Identifier.type.coding.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology
Identifier.type.coding.version 0..1 string Version of the system - if relevant
Identifier.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
Identifier.type.coding.display 0..1 string Representation defined by the system
Identifier.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Identifier.type.text 0..1 string Plain text representation of the concept
Identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
Identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Identifier.type Base extensible Identifier Type Codes 📍5.0.0 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())
ident-1 warning Identifier Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason value.exists()

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier An identifier intended for computation
Identifier.type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
Identifier.type.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Identifier.type.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology
Identifier.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
Identifier.system 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
Identifier.value 1..1 string The value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier C 0..* Identifier An identifier intended for computation
Constraints: ident-1
Identifier.id 0..1 id Unique id for inter-element referencing
Identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
Identifier.type.id 0..1 string Unique id for inter-element referencing
Identifier.type.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Identifier.type.coding.id 0..1 string Unique id for inter-element referencing
Identifier.type.coding.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology
Identifier.type.coding.version 0..1 string Version of the system - if relevant
Identifier.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
Identifier.type.coding.display 0..1 string Representation defined by the system
Identifier.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Identifier.type.text 0..1 string Plain text representation of the concept
Identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
Identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Identifier.type Base extensible Identifier Type Codes 📍5.0.0 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()
ident-1 warning Identifier Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier C 0..* Identifier An identifier intended for computation
Constraints: ident-1
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
Identifier.type.id 0..1 string Unique id for inter-element referencing
Identifier.type.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Identifier.type.coding.id 0..1 string Unique id for inter-element referencing
Identifier.type.coding.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology
Identifier.type.coding.version 0..1 string Version of the system - if relevant
Identifier.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
Identifier.type.coding.display 0..1 string Representation defined by the system
Identifier.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Identifier.type.text 0..1 string Plain text representation of the concept
Identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
Identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Identifier.type Base extensible Identifier Type Codes 📍5.0.0 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())
ident-1 warning Identifier Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason value.exists()

Differential View

This structure is derived from Identifier

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier 0..* Identifier An identifier intended for computation
Identifier.type 1..1 CodeableConcept Description of identifier
Required Pattern: At least the following
Identifier.type.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Identifier.type.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology
Identifier.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
Identifier.system 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
Identifier.value 1..1 string The value that is unique

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Identifier C 0..* Identifier An identifier intended for computation
Constraints: ident-1
Identifier.id 0..1 id Unique id for inter-element referencing
Identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Identifier.type This element is included in summaries. 1..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Required Pattern: At least the following
Identifier.type.id 0..1 string Unique id for inter-element referencing
Identifier.type.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Identifier.type.coding.id 0..1 string Unique id for inter-element referencing
Identifier.type.coding.extension 0..* Extension Additional content defined by implementations
Identifier.type.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r5/CodeSystem/codesystem-missing-dicom-terminology
Identifier.type.coding.version 0..1 string Version of the system - if relevant
Identifier.type.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
Identifier.type.coding.display 0..1 string Representation defined by the system
Identifier.type.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Identifier.type.text 0..1 string Plain text representation of the concept
Identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid
Identifier.value This element is included in summaries. C 1..1 string The value that is unique
Example General: 123456
Identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
Identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
Identifier.type Base extensible Identifier Type Codes 📍5.0.0 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()
ident-1 warning Identifier Identifier with no value has limited utility. If communicating that an identifier value has been suppressed or missing, the value element SHOULD be present with an extension indicating the missing semantic - e.g. data-absent-reason value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron