German Practice Management FHIR Profiles (R4)
0.49.0 - STU1 Germany flag

German Practice Management FHIR Profiles (R4) - Local Development build (v0.49.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ImagingStudy (Praxis DE)

Official URL: https://fhir.cognovis.de/praxis/StructureDefinition/imaging-study-praxis-de Version: 0.49.0
Active as of 2026-05-04 Computable Name: ImagingStudyPraxisDe
Other Identifiers: OID:2.16.840.1.113883.3.7985.42.107

Bildgebungs-Studie-Profil fuer die deutsche ambulante Praxis. Erbt von IPS ImagingStudy-uv-ips. Erweitert um DICOM-Modalitaet (required Binding), Koerperregion- und Lateralitaets-Slices, Ueberweiser-Tracking (referrer 1..1 fuer KV-Abrechnung), WADO-RS Endpoint, Kontrastmittel-Gabe-Extension und Aufnahmetechnik-Parameter-Extension.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kmAdministration S 0..1 (Complex) Image KM Administration
URL: https://fhir.cognovis.de/praxis/StructureDefinition/image-km-administration
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:accessionNumber SΣ 0..1 Identifier AccessionNumber (DICOM 0008,0050)
..... 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.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: ACSN
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.cognovis.de/praxis/NamingSystem/pvs-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality SΣ 0..* Coding Bildgebungsmodalitaet (DICOM CID 29, required)
Binding: DICOM Modality (required)
... subject SΣ 1..1 Reference(Patient (IPS)) Who or what is the subject of the study
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... started SΣ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... referrer SΣ 1..1 Reference(Practitioner | PractitionerRole) Ueberweisender Arzt (Pflichtfeld fuer KV-Abrechnung)
... endpoint SΣ 0..* Reference(DICOMweb Endpoint (Praxis DE)) DICOMweb Endpunkt fuer DICOM-Studie
... procedureCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Results Radiology Observation - IPS (extensible)
... reasonCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: ProcedureReasonCodes (example): The reason for the study.
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:techniqueParameter S 0..1 (Complex) Technique Parameter
URL: https://fhir.cognovis.de/praxis/StructureDefinition/technique-parameter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
.... bodySite Σ 0..1 Coding Koerperregion der Bildserie (SNOMED CT, preferred)
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality Σ 0..1 Coding Seitenangabe (preferred Binding: bodysite-laterality)
Binding: Laterality (preferred)
.... instance S 0..* BackboneElement A single SOP instance from the series
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.identifier:accessionNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ImagingStudy.identifier:accessionNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.modality Base required DICOM Modality 📦0.49.0 This IG
ImagingStudy.procedureCode Base extensible Results Radiology Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
ImagingStudy.reasonCode Base example Procedure Reason Codes 📦4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality 📦2022.4.20221006 DICOM v2022d
ImagingStudy.series.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base preferred Laterality 📦4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
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 ImagingStudyUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kmAdministration S 0..1 (Complex) Image KM Administration
URL: https://fhir.cognovis.de/praxis/StructureDefinition/image-km-administration
... Slices for identifier 0..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:type.coding.code
.... identifier:accessionNumber S 0..1 Identifier AccessionNumber (DICOM 0008,0050)
..... type
...... coding
....... system S 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: ACSN
..... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.cognovis.de/praxis/NamingSystem/pvs-id
..... value S 1..1 string The value that is unique
... modality S 0..* Coding Bildgebungsmodalitaet (DICOM CID 29, required)
Binding: DICOM Modality (required)
... endpoint S 0..* Reference(DICOMweb Endpoint (Praxis DE)) DICOMweb Endpunkt fuer DICOM-Studie
... series
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:techniqueParameter S 0..1 (Complex) Technique Parameter
URL: https://fhir.cognovis.de/praxis/StructureDefinition/technique-parameter
.... bodySite 0..1 Coding Koerperregion der Bildserie (SNOMED CT, preferred)
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 Coding Seitenangabe (preferred Binding: bodysite-laterality)
Binding: Laterality (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingStudy.modality Base required DICOM Modality 📦0.49.0 This IG
ImagingStudy.series.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base preferred Laterality 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kmAdministration S 0..1 (Complex) Image KM Administration
URL: https://fhir.cognovis.de/praxis/StructureDefinition/image-km-administration
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:type.coding.code
.... identifier:accessionNumber SΣ 0..1 Identifier AccessionNumber (DICOM 0008,0050)
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: ACSN
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.cognovis.de/praxis/NamingSystem/pvs-id
..... value SΣ 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)
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality SΣ 0..* Coding Bildgebungsmodalitaet (DICOM CID 29, required)
Binding: DICOM Modality (required)
... subject SΣ 1..1 Reference(Patient (IPS)) Who or what is the subject of the study
.... 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 SΣC 1..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 Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started SΣ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
... referrer SΣ 1..1 Reference(Practitioner | PractitionerRole) Ueberweisender Arzt (Pflichtfeld fuer KV-Abrechnung)
... interpreter Σ 0..* Reference(Practitioner | PractitionerRole) Who interpreted images
... endpoint SΣ 0..* Reference(DICOMweb Endpoint (Praxis DE)) DICOMweb Endpunkt fuer DICOM-Studie
... numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedureReference Σ 0..1 Reference(Procedure) The performed Procedure reference
... procedureCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Results Radiology Observation - IPS (extensible)
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reasonCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: ProcedureReasonCodes (example): The reason for the study.
... reasonReference Σ 0..* Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Why was study performed
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:techniqueParameter S 0..1 (Complex) Technique Parameter
URL: https://fhir.cognovis.de/praxis/StructureDefinition/technique-parameter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... endpoint Σ 0..* Reference(Endpoint) Series access endpoint
.... bodySite Σ 0..1 Coding Koerperregion der Bildserie (SNOMED CT, preferred)
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality Σ 0..1 Coding Seitenangabe (preferred Binding: bodysite-laterality)
Binding: Laterality (preferred)
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... performer Σ 0..* BackboneElement Who performed the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept Type of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance S 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.
..... number 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📦4.0.1 FHIR Std.
ImagingStudy.identifier:accessionNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ImagingStudy.identifier:accessionNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.modality Base required DICOM Modality 📦0.49.0 This IG
ImagingStudy.subject.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
ImagingStudy.procedureCode Base extensible Results Radiology Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
ImagingStudy.reasonCode Base example Procedure Reason Codes 📦4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality 📦2022.4.20221006 DICOM v2022d
ImagingStudy.series.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base preferred Laterality 📦4.0.1 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📦4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
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 ImagingStudyUvIps

Summary

Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kmAdministration S 0..1 (Complex) Image KM Administration
URL: https://fhir.cognovis.de/praxis/StructureDefinition/image-km-administration
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:accessionNumber SΣ 0..1 Identifier AccessionNumber (DICOM 0008,0050)
..... 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.
...... coding Σ 0..* Coding Code defined by a terminology system
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: ACSN
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.cognovis.de/praxis/NamingSystem/pvs-id
..... value SΣ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality SΣ 0..* Coding Bildgebungsmodalitaet (DICOM CID 29, required)
Binding: DICOM Modality (required)
... subject SΣ 1..1 Reference(Patient (IPS)) Who or what is the subject of the study
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... started SΣ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... referrer SΣ 1..1 Reference(Practitioner | PractitionerRole) Ueberweisender Arzt (Pflichtfeld fuer KV-Abrechnung)
... endpoint SΣ 0..* Reference(DICOMweb Endpoint (Praxis DE)) DICOMweb Endpunkt fuer DICOM-Studie
... procedureCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Results Radiology Observation - IPS (extensible)
... reasonCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: ProcedureReasonCodes (example): The reason for the study.
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:techniqueParameter S 0..1 (Complex) Technique Parameter
URL: https://fhir.cognovis.de/praxis/StructureDefinition/technique-parameter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
.... bodySite Σ 0..1 Coding Koerperregion der Bildserie (SNOMED CT, preferred)
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality Σ 0..1 Coding Seitenangabe (preferred Binding: bodysite-laterality)
Binding: Laterality (preferred)
.... instance S 0..* BackboneElement A single SOP instance from the series
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.identifier:accessionNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ImagingStudy.identifier:accessionNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.modality Base required DICOM Modality 📦0.49.0 This IG
ImagingStudy.procedureCode Base extensible Results Radiology Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
ImagingStudy.reasonCode Base example Procedure Reason Codes 📦4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality 📦2022.4.20221006 DICOM v2022d
ImagingStudy.series.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base preferred Laterality 📦4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
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 ImagingStudyUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kmAdministration S 0..1 (Complex) Image KM Administration
URL: https://fhir.cognovis.de/praxis/StructureDefinition/image-km-administration
... Slices for identifier 0..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:type.coding.code
.... identifier:accessionNumber S 0..1 Identifier AccessionNumber (DICOM 0008,0050)
..... type
...... coding
....... system S 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... code 1..1 code Symbol in syntax defined by the system
Required Pattern: ACSN
..... system S 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.cognovis.de/praxis/NamingSystem/pvs-id
..... value S 1..1 string The value that is unique
... modality S 0..* Coding Bildgebungsmodalitaet (DICOM CID 29, required)
Binding: DICOM Modality (required)
... endpoint S 0..* Reference(DICOMweb Endpoint (Praxis DE)) DICOMweb Endpunkt fuer DICOM-Studie
... series
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:techniqueParameter S 0..1 (Complex) Technique Parameter
URL: https://fhir.cognovis.de/praxis/StructureDefinition/technique-parameter
.... bodySite 0..1 Coding Koerperregion der Bildserie (SNOMED CT, preferred)
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality 0..1 Coding Seitenangabe (preferred Binding: bodysite-laterality)
Binding: Laterality (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ImagingStudy.modality Base required DICOM Modality 📦0.49.0 This IG
ImagingStudy.series.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base preferred Laterality 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImagingStudy 0..* ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:kmAdministration S 0..1 (Complex) Image KM Administration
URL: https://fhir.cognovis.de/praxis/StructureDefinition/image-km-administration
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier Identifiers for the whole study
Slice: Unordered, Open by value:type.coding.code
.... identifier:accessionNumber SΣ 0..1 Identifier AccessionNumber (DICOM 0008,0050)
..... 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.
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ 0..* Coding Code defined by a terminology system
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
....... version Σ 0..1 string Version of the system - if relevant
....... code Σ 1..1 code Symbol in syntax defined by the system
Required Pattern: ACSN
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
...... text Σ 0..1 string Plain text representation of the concept
..... system SΣ 1..1 uri The namespace for the identifier value
Required Pattern: https://fhir.cognovis.de/praxis/NamingSystem/pvs-id
..... value SΣ 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)
... status ?!Σ 1..1 code registered | available | cancelled | entered-in-error | unknown
Binding: ImagingStudyStatus (required): The status of the ImagingStudy.
... modality SΣ 0..* Coding Bildgebungsmodalitaet (DICOM CID 29, required)
Binding: DICOM Modality (required)
... subject SΣ 1..1 Reference(Patient (IPS)) Who or what is the subject of the study
.... 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 SΣC 1..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 Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter with which this imaging study is associated
... started SΣ 0..1 dateTime When the study was started
Example General: 2011-01-01T11:01:20+03:00
... basedOn Σ 0..* Reference(CarePlan | ServiceRequest | Appointment | AppointmentResponse | Task) Request fulfilled
... referrer SΣ 1..1 Reference(Practitioner | PractitionerRole) Ueberweisender Arzt (Pflichtfeld fuer KV-Abrechnung)
... interpreter Σ 0..* Reference(Practitioner | PractitionerRole) Who interpreted images
... endpoint SΣ 0..* Reference(DICOMweb Endpoint (Praxis DE)) DICOMweb Endpunkt fuer DICOM-Studie
... numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
... numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
... procedureReference Σ 0..1 Reference(Procedure) The performed Procedure reference
... procedureCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Results Radiology Observation - IPS (extensible)
... location Σ 0..1 Reference(Location) Where ImagingStudy occurred
... reasonCode S 0..* CodeableConceptIPS Concept - reference to a terminology or just text
Binding: ProcedureReasonCodes (example): The reason for the study.
... reasonReference Σ 0..* Reference(Condition | Observation | Media | DiagnosticReport | DocumentReference) Why was study performed
... note Σ 0..* Annotation User-defined comments
... description Σ 0..1 string Institution-generated description
... series SΣ 0..* BackboneElement Each study has one or more series of instances
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:techniqueParameter S 0..1 (Complex) Technique Parameter
URL: https://fhir.cognovis.de/praxis/StructureDefinition/technique-parameter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... uid SΣ 1..1 id DICOM Series Instance UID for the series
Example General: 2.16.124.113543.6003.2588828330.45298.17418.2723805630
.... number Σ 0..1 unsignedInt Numeric identifier of this series
Example General: 3
.... modality SΣ 1..1 Coding The modality of the instances in the series
Binding: AcquisitionModality (extensible): Type of acquired data in the instance.
.... description Σ 0..1 string A short human readable summary of the series
Example General: CT Surview 180
.... numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
.... endpoint Σ 0..* Reference(Endpoint) Series access endpoint
.... bodySite Σ 0..1 Coding Koerperregion der Bildserie (SNOMED CT, preferred)
Binding: SNOMEDCTBodyStructures (preferred)
.... laterality Σ 0..1 Coding Seitenangabe (preferred Binding: bodysite-laterality)
Binding: Laterality (preferred)
.... specimen Σ 0..* Reference(Specimen) Specimen imaged
.... started Σ 0..1 dateTime When the series started
.... performer Σ 0..* BackboneElement Who performed the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... function Σ 0..1 CodeableConcept Type of performance
Binding: ImagingStudySeriesPerformerFunction (extensible): The type of involvement of the performer.
..... actor Σ 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Who performed the series
.... instance S 0..* BackboneElement A single SOP instance from the series
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... uid S 1..1 id DICOM SOP Instance UID
Example General: 2.16.124.113543.6003.189642796.63084.16748.2599092903
..... sopClass S 1..1 Coding DICOM class type
Binding: http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 (extensible): The sopClass for the instance.
..... number 0..1 unsignedInt The number of this instance in the series
Example General: 1
..... title 0..1 string Description of instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImagingStudy.language Base preferred Common Languages 📦4.0.1 FHIR Std.
ImagingStudy.identifier:accessionNumber.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
ImagingStudy.identifier:accessionNumber.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
ImagingStudy.status Base required ImagingStudyStatus 📍4.0.1 FHIR Std.
ImagingStudy.modality Base required DICOM Modality 📦0.49.0 This IG
ImagingStudy.subject.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
ImagingStudy.procedureCode Base extensible Results Radiology Observation - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
ImagingStudy.reasonCode Base example Procedure Reason Codes 📦4.0.1 FHIR Std.
ImagingStudy.series.​modality Base extensible AcquisitionModality 📦2022.4.20221006 DICOM v2022d
ImagingStudy.series.​bodySite Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
ImagingStudy.series.​laterality Base preferred Laterality 📦4.0.1 FHIR Std.
ImagingStudy.series.​performer.function Base extensible ImagingStudy series performer function 📦4.0.1 FHIR Std.
ImagingStudy.series.​instance.sopClass Base extensible http://dicom.nema.org/medical/dicom/current/output/chtml/part04/sect_B.5.html#table_B.5-1 Not State Unknown

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImagingStudy If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImagingStudy If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ImagingStudy If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImagingStudy A resource should have narrative for robust management text.`div`.exists()
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 ImagingStudyUvIps

Summary

Mandatory: 1 element(4 nested mandatory elements)
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImagingStudy.identifier

 

Other representations of profile: CSV, Excel, Schematron