EU Imaging Manifest and Access (IHE-MADO additions)
1.0.0-ballot - ballot
150
EU Imaging Manifest and Access (IHE-MADO additions)
1.0.0-ballot - ballot
150
This page is part of the EU Manifest-based Access to DICOM Objects (EU-MADO) (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-manifest/StructureDefinition/EuMadoComposition | Version: 1.0.0-ballot | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EuMadoComposition | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Profile on MadoComposition that specifies the EU specific elements.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Composition |
0..* | MadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation This profile also complies with the profile Composition (EU core) | |||||||||||
  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.
| |||||||||||
  text |
1..1 | Narrative | A human readable narrative that contains information about the manifest. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||
 status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
 div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier |
1..1 | Identifier | An OID according for a FHIR-Based formatted Imaging Study Manifest. The OID is structured according to the DICOM UI value representation. In the case that a DICOM KOS manifest is present, this field will hold the same value as the SOP Instance UID of the corresponding translated DICOM KOS manifest.
| |||||||||||
| status |
1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
| |||||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern:
| |||||||||||
| category |
0..* | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3. Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
| |||||||||||
 subject |
1..1 | Reference(EU MADO Patient) | Who and/or what the composition is about
| |||||||||||
| date |
1..1 | dateTime | When the manifest was created.
| |||||||||||
 Slices for author |
2..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve() | |||||||||||
  author:source-organization |
1..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| |||||||||||
 author:source-device |
1..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| |||||||||||
| title |
1..1 | string | Human readable title to display for the manifest.
| |||||||||||
| custodian |
0..1 | Reference(Organization) | The organization that is the custodian of the manifest.
| |||||||||||
| Slices for event |
1..* | BackboneElement | The clinical service(s) being documented Slice: Unordered, Open by profile:detail.resolve() | |||||||||||
  event:All Slices |
Content/Rules for all slices | |||||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
 event:imaging-study |
1..1 | BackboneElement | The clinical service(s) being documented
| |||||||||||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
 detail |
0..* | Reference(MADO EU Imaging Study) | Reference to the ImagingStudy that contains the details of the study that is being described in the manifest. | |||||||||||
 section |
C | 0..* | BackboneElement | Optionally, one or more sections. Each section provides information on a series in the study. Constraints: cmp-1, cmp-2
| ||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| text |
C | 1..1 | Narrative | A human readable narrative that contains the information about the section. This narrative could contain information like: the series instance UID, the series description, the number of instances in the series, and/or the modality. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| Documentation for this format | ||||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Composition.text.status | Base | required | ValueSet: Non-empty Narrative status codes | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.0.1 | FHIR Std. |
| Composition.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
| Composition.section.text.status | Base | required | ValueSet: Non-empty Narrative status codes | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
| txt-1 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from MadoComposition
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Composition |
MadoComposition | This profile also complies with the profile Composition (EU core) | ||||||||
| language |
0..1 | code | Language of the resource content
| |||||||
| text |
1..1 | Narrative | A human readable narrative that contains information about the manifest.
| |||||||
| identifier |
1..1 | Identifier | An OID according for a FHIR-Based formatted Imaging Study Manifest. The OID is structured according to the DICOM UI value representation. In the case that a DICOM KOS manifest is present, this field will hold the same value as the SOP Instance UID of the corresponding translated DICOM KOS manifest.
| |||||||
| status |
1..1 | code | preliminary | final | amended | entered-in-error
| |||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Required Pattern:
| |||||||
| category |
0..* | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3.
| |||||||
| subject |
1..1 | Reference(EU MADO Patient) | Who and/or what the composition is about
| |||||||
| date |
1..1 | dateTime | When the manifest was created.
| |||||||
| Slices for author |
Content/Rules for all slices | |||||||||
| author:source-organization |
1..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| |||||||
| author:source-device |
1..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| |||||||
| title |
1..1 | string | Human readable title to display for the manifest.
| |||||||
| custodian |
0..1 | Reference(Organization) | The organization that is the custodian of the manifest.
| |||||||
| Slices for event |
Content/Rules for all slices | |||||||||
| event:imaging-study |
1..1 | BackboneElement | The clinical service(s) being documented
| |||||||
| detail |
0..* | Reference(MADO EU Imaging Study) | Reference to the ImagingStudy that contains the details of the study that is being described in the manifest. | |||||||
| section |
0..* | BackboneElement | Optionally, one or more sections. Each section provides information on a series in the study.
| |||||||
| text |
1..1 | Narrative | A human readable narrative that contains the information about the section. This narrative could contain information like: the series instance UID, the series description, the number of instances in the series, and/or the modality.
| |||||||
| Documentation for this format | ||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | MadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation This profile also complies with the profile Composition (EU core) | |||||||||||
| 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.
| |||||||||||
| text |
1..1 | Narrative | A human readable narrative that contains information about the manifest. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier |
1..1 | Identifier | An OID according for a FHIR-Based formatted Imaging Study Manifest. The OID is structured according to the DICOM UI value representation. In the case that a DICOM KOS manifest is present, this field will hold the same value as the SOP Instance UID of the corresponding translated DICOM KOS manifest.
| |||||||||||
| status |
1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
| |||||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern:
| |||||||||||
| category |
0..* | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3. Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
| |||||||||||
| subject |
1..1 | Reference(EU MADO Patient) | Who and/or what the composition is about
| |||||||||||
| encounter |
0..1 | Reference(Encounter) | Context of the Composition | |||||||||||
| date |
1..1 | dateTime | When the manifest was created.
| |||||||||||
| Slices for author |
2..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve() | |||||||||||
| author:source-organization |
1..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| |||||||||||
| author:source-device |
1..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| |||||||||||
| title |
1..1 | string | Human readable title to display for the manifest.
| |||||||||||
| confidentiality |
0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | |||||||||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||||||||
| 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 | |||||||||||
| mode |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||||||||
| time |
0..1 | dateTime | When the composition was attested | |||||||||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||||||||
| custodian |
0..1 | Reference(Organization) | The organization that is the custodian of the manifest.
| |||||||||||
| relatesTo |
0..* | BackboneElement | Relationships to other compositions/documents | |||||||||||
| 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 | |||||||||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||||||||
 target[x] |
1..1 | Target of the relationship | ||||||||||||
| targetIdentifier |
Identifier | |||||||||||||
| targetReference |
Reference(Composition) | |||||||||||||
| Slices for event |
1..* | BackboneElement | The clinical service(s) being documented Slice: Unordered, Open by profile:detail.resolve() | |||||||||||
| event:All Slices |
Content/Rules for all slices | |||||||||||||
| 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 | |||||||||||
| code |
0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||||
| period |
0..1 | Period | The period covered by the documentation | |||||||||||
| detail |
0..* | Reference(Resource) | The event(s) being documented | |||||||||||
| event:imaging-study |
1..1 | BackboneElement | The clinical service(s) being documented
| |||||||||||
| 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 | |||||||||||
| code |
0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||||
| period |
0..1 | Period | The period covered by the documentation | |||||||||||
| detail |
0..* | Reference(MADO EU Imaging Study) | Reference to the ImagingStudy that contains the details of the study that is being described in the manifest. | |||||||||||
| section |
C | 0..* | BackboneElement | Optionally, one or more sections. Each section provides information on a series in the study. Constraints: cmp-1, cmp-2
| ||||||||||
| 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 | |||||||||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||||||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||||||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||||||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||||||||
| text |
C | 1..1 | Narrative | A human readable narrative that contains the information about the section. This narrative could contain information like: the series instance UID, the series description, the number of instances in the series, and/or the modality. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||||||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||||||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||||||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||||||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||||||||
| Documentation for this format | ||||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
| txt-1 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
This structure is derived from MadoComposition
Summary
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | MadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation This profile also complies with the profile Composition (EU core) | |||||||||||
| 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.
| |||||||||||
| text |
1..1 | Narrative | A human readable narrative that contains information about the manifest. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier |
1..1 | Identifier | An OID according for a FHIR-Based formatted Imaging Study Manifest. The OID is structured according to the DICOM UI value representation. In the case that a DICOM KOS manifest is present, this field will hold the same value as the SOP Instance UID of the corresponding translated DICOM KOS manifest.
| |||||||||||
| status |
1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
| |||||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern:
| |||||||||||
| category |
0..* | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3. Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
| |||||||||||
| subject |
1..1 | Reference(EU MADO Patient) | Who and/or what the composition is about
| |||||||||||
| date |
1..1 | dateTime | When the manifest was created.
| |||||||||||
| Slices for author |
2..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve() | |||||||||||
| author:source-organization |
1..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| |||||||||||
| author:source-device |
1..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| |||||||||||
| title |
1..1 | string | Human readable title to display for the manifest.
| |||||||||||
| custodian |
0..1 | Reference(Organization) | The organization that is the custodian of the manifest.
| |||||||||||
| Slices for event |
1..* | BackboneElement | The clinical service(s) being documented Slice: Unordered, Open by profile:detail.resolve() | |||||||||||
| event:All Slices |
Content/Rules for all slices | |||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| event:imaging-study |
1..1 | BackboneElement | The clinical service(s) being documented
| |||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| detail |
0..* | Reference(MADO EU Imaging Study) | Reference to the ImagingStudy that contains the details of the study that is being described in the manifest. | |||||||||||
| section |
C | 0..* | BackboneElement | Optionally, one or more sections. Each section provides information on a series in the study. Constraints: cmp-1, cmp-2
| ||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||
| text |
C | 1..1 | Narrative | A human readable narrative that contains the information about the section. This narrative could contain information like: the series instance UID, the series description, the number of instances in the series, and/or the modality. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| Documentation for this format | ||||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Composition.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Composition.text.status | Base | required | ValueSet: Non-empty Narrative status codes | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| Composition.status | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| Composition.type | Base | preferred | FHIR Document Type Codes | 📍4.0.1 | FHIR Std. |
| Composition.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
| Composition.section.text.status | Base | required | ValueSet: Non-empty Narrative status codes | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
| txt-1 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
Differential View
This structure is derived from MadoComposition
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Composition |
MadoComposition | This profile also complies with the profile Composition (EU core) | ||||||||
| language |
0..1 | code | Language of the resource content
| |||||||
| text |
1..1 | Narrative | A human readable narrative that contains information about the manifest.
| |||||||
| identifier |
1..1 | Identifier | An OID according for a FHIR-Based formatted Imaging Study Manifest. The OID is structured according to the DICOM UI value representation. In the case that a DICOM KOS manifest is present, this field will hold the same value as the SOP Instance UID of the corresponding translated DICOM KOS manifest.
| |||||||
| status |
1..1 | code | preliminary | final | amended | entered-in-error
| |||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Required Pattern:
| |||||||
| category |
0..* | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3.
| |||||||
| subject |
1..1 | Reference(EU MADO Patient) | Who and/or what the composition is about
| |||||||
| date |
1..1 | dateTime | When the manifest was created.
| |||||||
| Slices for author |
Content/Rules for all slices | |||||||||
| author:source-organization |
1..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| |||||||
| author:source-device |
1..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| |||||||
| title |
1..1 | string | Human readable title to display for the manifest.
| |||||||
| custodian |
0..1 | Reference(Organization) | The organization that is the custodian of the manifest.
| |||||||
| Slices for event |
Content/Rules for all slices | |||||||||
| event:imaging-study |
1..1 | BackboneElement | The clinical service(s) being documented
| |||||||
| detail |
0..* | Reference(MADO EU Imaging Study) | Reference to the ImagingStudy that contains the details of the study that is being described in the manifest. | |||||||
| section |
0..* | BackboneElement | Optionally, one or more sections. Each section provides information on a series in the study.
| |||||||
| text |
1..1 | Narrative | A human readable narrative that contains the information about the section. This narrative could contain information like: the series instance UID, the series description, the number of instances in the series, and/or the modality.
| |||||||
| Documentation for this format | ||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Composition |
0..* | MadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation This profile also complies with the profile Composition (EU core) | |||||||||||
| 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.
| |||||||||||
| text |
1..1 | Narrative | A human readable narrative that contains information about the manifest. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| |||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||
| identifier |
1..1 | Identifier | An OID according for a FHIR-Based formatted Imaging Study Manifest. The OID is structured according to the DICOM UI value representation. In the case that a DICOM KOS manifest is present, this field will hold the same value as the SOP Instance UID of the corresponding translated DICOM KOS manifest.
| |||||||||||
| status |
1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
| |||||||||||
| type |
1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern:
| |||||||||||
| category |
0..* | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3. Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
| |||||||||||
| subject |
1..1 | Reference(EU MADO Patient) | Who and/or what the composition is about
| |||||||||||
| encounter |
0..1 | Reference(Encounter) | Context of the Composition | |||||||||||
| date |
1..1 | dateTime | When the manifest was created.
| |||||||||||
| Slices for author |
2..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve() | |||||||||||
| author:source-organization |
1..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| |||||||||||
| author:source-device |
1..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| |||||||||||
| title |
1..1 | string | Human readable title to display for the manifest.
| |||||||||||
| confidentiality |
0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | |||||||||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||||||||
| 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 | |||||||||||
| mode |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||||||||
| time |
0..1 | dateTime | When the composition was attested | |||||||||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||||||||
| custodian |
0..1 | Reference(Organization) | The organization that is the custodian of the manifest.
| |||||||||||
| relatesTo |
0..* | BackboneElement | Relationships to other compositions/documents | |||||||||||
| 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 | |||||||||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||||||||
| target[x] |
1..1 | Target of the relationship | ||||||||||||
| targetIdentifier |
Identifier | |||||||||||||
| targetReference |
Reference(Composition) | |||||||||||||
| Slices for event |
1..* | BackboneElement | The clinical service(s) being documented Slice: Unordered, Open by profile:detail.resolve() | |||||||||||
| event:All Slices |
Content/Rules for all slices | |||||||||||||
| 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 | |||||||||||
| code |
0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||||
| period |
0..1 | Period | The period covered by the documentation | |||||||||||
| detail |
0..* | Reference(Resource) | The event(s) being documented | |||||||||||
| event:imaging-study |
1..1 | BackboneElement | The clinical service(s) being documented
| |||||||||||
| 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 | |||||||||||
| code |
0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||||
| period |
0..1 | Period | The period covered by the documentation | |||||||||||
| detail |
0..* | Reference(MADO EU Imaging Study) | Reference to the ImagingStudy that contains the details of the study that is being described in the manifest. | |||||||||||
| section |
C | 0..* | BackboneElement | Optionally, one or more sections. Each section provides information on a series in the study. Constraints: cmp-1, cmp-2
| ||||||||||
| 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 | |||||||||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||||||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||||||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||||||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||||||||
| text |
C | 1..1 | Narrative | A human readable narrative that contains the information about the section. This narrative could contain information like: the series instance UID, the series description, the number of instances in the series, and/or the modality. This profile does not constrain the narrative in regard to content, language, or traceability to data elements
| ||||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: ValueSet: Non-empty Narrative status codes (required) | |||||||||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||||||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||||||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||||||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||||||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||||||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||||||||
| Documentation for this format | ||||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
| Id | Grade | Path(s) | Description | Expression |
| cmp-1 | error | Composition.section | A section must contain at least one of text, entries, or sub-sections |
text.exists() or entry.exists() or section.exists()
|
| cmp-2 | error | Composition.section | A section can only have an emptyReason if it is empty |
emptyReason.empty() or entry.empty()
|
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Composition | 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 | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Composition | 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()
|
| txt-1 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Composition.text.div, Composition.section.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
| Name | Content Creator/Document Source (Imaging Manifest) | Document Consumer (Imaging Manifest) |
|---|---|---|
| Composition |
||
| language |
|
|
| text |
|
|
| identifier |
|
|
| status |
|
|
| type |
|
|
| category |
|
|
| subject |
|
|
| date |
|
|
| Slices for author |
||
| author:source-organization |
|
|
| author:source-device |
|
|
| title |
|
|
| custodian |
|
|
| Slices for event |
||
| event:imaging-study |
|
|
| section |
|
|
| text |
|
|
| Documentation for this format | ||
This structure is derived from MadoComposition
Summary
Must-Support: 5 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.imaging-manifest#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-10-16
