HL7 Europe Imaging Study Report
0.1.0-ballot - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/tree/master and changes regularly. See the Directory of published versions

Data Type Profile: Imaging SOP Class UID Identifier

Official URL: http://hl7.eu/fhir/imaging-r4/StructureDefinition/im-sop-instance-uid-identifier Version: 0.1.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: ImSopInstanceUidIdentifier

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

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

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Σ 1..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.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-missing-dicom-terminology
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
..... display 1..1 string Representation defined by the system
Fixed Value: SOP Instance UID
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Identifier.typeextensiblePattern Value: 00080018("SOP Instance UID")
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from Identifier

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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 .
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-missing-dicom-terminology
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
..... display 1..1 string Representation defined by the system
Fixed Value: SOP Instance UID
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom: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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Identifier.typeextensiblePattern Value: 00080018("SOP Instance UID")
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Σ 1..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.
Required Pattern: At least the following
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-missing-dicom-terminology
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
..... display 1..1 string Representation defined by the system
Fixed Value: SOP Instance UID
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom:uid

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Identifier.typeextensiblePattern Value: 00080018("SOP Instance UID")
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Identifier

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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 .
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://hl7.eu/fhir/imaging-r4/CodeSystem/codesystem-missing-dicom-terminology
..... version 0..1 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 00080018
..... display 1..1 string Representation defined by the system
Fixed Value: SOP Instance UID
..... userSelected 0..1 boolean If this coding was chosen directly by the user
.... text 0..1 string Plain text representation of the concept
... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:dicom: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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Identifier.typeextensiblePattern Value: 00080018("SOP Instance UID")
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Identifier

Summary

Mandatory: 2 elements

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron