Manifest-based Access to DICOM Objects (IHE-MADO) - EU Extensions
0.2.1-build - ci-build
150
Manifest-based Access to DICOM Objects (IHE-MADO) - EU Extensions
0.2.1-build - ci-build
150
Manifest-based Access to DICOM Objects (IHE-MADO) - EU Extensions, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.1-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-manifest/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-manifest/StructureDefinition/EuMadoBundle | Version: 0.2.1-build | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EuMadoBundle | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
This profile refines the MadoFhirBundle with EU specific elements for the MADO EU FHIR Imaging Study Manifest. It includes the necessary resources and rules to represent the imaging study manifest in compliance with the MADO specifications.
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:   | ||||
|---|---|---|---|---|---|---|---|---|
  Bundle |
C | 0..* | MadoFhirBundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
 identifier |
SOΣ | 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.
| ||||
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: document | ||||
| timestamp |
SOΣ | 1..1 | instant | When the bundle was assembled
| ||||
  Slices for entry |
ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
   entry:All Slices |
Content/Rules for all slices | |||||||
   modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
 resource |
Σ | 1..1 | Resource | A resource in the bundle | ||||
 entry:composition |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
 resource |
1..1 | EuMadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| entry:imaging-study |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| entry:patient |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoPatient | Information about an individual or animal receiving health care services | |||||
| entry:wado-endpoint |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoWadoEndpoint | Endpoint for retrieval of the study data. | |||||
| entry:web-endpoint |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoWebViewerEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| entry:creator-device |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreator | The author of the manifest. | |||||
| entry:creator-organization |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreatorOrganization | The organization of the author of the manifest. | |||||
 entry:requested-procedure |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoRequestedProcedure | A request for a service to be performed | |||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:imaging-study.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:wado-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:web-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-device.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requested-procedure.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| 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()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
0..* | MadoFhirBundle | Contains a collection of resources | |||||
| identifier |
O | 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.
| ||||
| timestamp |
O | 1..1 | instant | When the bundle was assembled
| ||||
 entry |
4..* | BackboneElement | Entry in the bundle - will have a resource or information | |||||
 fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | Resource | A resource in the bundle | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
 response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| Slices for entry |
Content/Rules for all slices | |||||||
| entry:composition |
O | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:imaging-study |
O | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:patient |
O | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoPatient | Information about an individual or animal receiving health care services | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:wado-endpoint |
O | 1..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | MadoWadoEndpoint | Endpoint for retrieval of the study data. | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:web-endpoint |
O | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoWebViewerEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:creator-device |
O | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | MadoCreator | The author of the manifest. | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:creator-organization |
O | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | MadoCreatorOrganization | The organization of the author of the manifest. | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:requested-procedure |
O | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoRequestedProcedure | A request for a service to be performed | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MadoFhirBundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| 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.
| |||||
| identifier |
SOΣ | 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.
| ||||
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: document | ||||
| timestamp |
SOΣ | 1..1 | instant | When the bundle was assembled
| ||||
| link |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| 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 | ||||
| relation |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url |
Σ | 1..1 | uri | Reference details for the link | ||||
| Slices for entry |
ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry: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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
Σ | 1..1 | Resource | A resource in the bundle | ||||
| entry:composition |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| entry:imaging-study |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| entry:patient |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoPatient | Information about an individual or animal receiving health care services | |||||
| entry:wado-endpoint |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoWadoEndpoint | Endpoint for retrieval of the study data. | |||||
| entry:web-endpoint |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoWebViewerEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| entry:creator-device |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreator | The author of the manifest. | |||||
| entry:creator-organization |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreatorOrganization | The organization of the author of the manifest. | |||||
| entry:requested-procedure |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoRequestedProcedure | A request for a service to be performed | |||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:imaging-study.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:imaging-study.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:wado-endpoint.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:wado-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:web-endpoint.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:web-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-device.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-device.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requested-procedure.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requested-procedure.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| 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()
|
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
Summary
Mandatory: 10 elements(8 nested mandatory elements)
Prohibited: 27 elements
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MadoFhirBundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| identifier |
SOΣ | 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.
| ||||
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: document | ||||
| timestamp |
SOΣ | 1..1 | instant | When the bundle was assembled
| ||||
| Slices for entry |
ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry:All Slices |
Content/Rules for all slices | |||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
Σ | 1..1 | Resource | A resource in the bundle | ||||
| entry:composition |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| entry:imaging-study |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| entry:patient |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoPatient | Information about an individual or animal receiving health care services | |||||
| entry:wado-endpoint |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoWadoEndpoint | Endpoint for retrieval of the study data. | |||||
| entry:web-endpoint |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoWebViewerEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| entry:creator-device |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreator | The author of the manifest. | |||||
| entry:creator-organization |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreatorOrganization | The organization of the author of the manifest. | |||||
| entry:requested-procedure |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoRequestedProcedure | A request for a service to be performed | |||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:imaging-study.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:wado-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:web-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-device.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requested-procedure.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
0..* | MadoFhirBundle | Contains a collection of resources | |||||
| identifier |
O | 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.
| ||||
| timestamp |
O | 1..1 | instant | When the bundle was assembled
| ||||
| entry |
4..* | BackboneElement | Entry in the bundle - will have a resource or information | |||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | Resource | A resource in the bundle | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| Slices for entry |
Content/Rules for all slices | |||||||
| entry:composition |
O | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:imaging-study |
O | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:patient |
O | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoPatient | Information about an individual or animal receiving health care services | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:wado-endpoint |
O | 1..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | MadoWadoEndpoint | Endpoint for retrieval of the study data. | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:web-endpoint |
O | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoWebViewerEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:creator-device |
O | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | MadoCreator | The author of the manifest. | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:creator-organization |
O | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | MadoCreatorOrganization | The organization of the author of the manifest. | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| entry:requested-procedure |
O | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
| ||||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | EuMadoRequestedProcedure | A request for a service to be performed | |||||
| search |
0..0 | Search related information | ||||||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||||||
| response |
0..0 | Results of execution (transaction/batch/history) | ||||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MadoFhirBundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12 | ||||
| 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.
| |||||
| identifier |
SOΣ | 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.
| ||||
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: document | ||||
| timestamp |
SOΣ | 1..1 | instant | When the bundle was assembled
| ||||
| link |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| 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 | ||||
| relation |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url |
Σ | 1..1 | uri | Reference details for the link | ||||
| Slices for entry |
ΣC | 4..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource, profile:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| entry: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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
Σ | 1..1 | Resource | A resource in the bundle | ||||
| entry:composition |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| entry:imaging-study |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoImagingStudy | A set of images produced in single study (one or more series of references images) | |||||
| entry:patient |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoPatient | Information about an individual or animal receiving health care services | |||||
| entry:wado-endpoint |
SOΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoWadoEndpoint | Endpoint for retrieval of the study data. | |||||
| entry:web-endpoint |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoWebViewerEndpoint | The technical details of an endpoint that can be used for electronic services | |||||
| entry:creator-device |
SOΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreator | The author of the manifest. | |||||
| entry:creator-organization |
SOΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | MadoCreatorOrganization | The organization of the author of the manifest. | |||||
| entry:requested-procedure |
SOΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
| ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
1..1 | EuMadoRequestedProcedure | A request for a service to be performed | |||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:imaging-study.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:imaging-study.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:wado-endpoint.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:wado-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:web-endpoint.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:web-endpoint.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-device.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-device.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:creator-organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requested-procedure.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:requested-procedure.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | must be a resource unless there's a request or response |
resource.exists() or request.exists() or response.exists()
|
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) |
(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:imaging-study, Bundle.entry:patient, Bundle.entry:wado-endpoint, Bundle.entry:web-endpoint, Bundle.entry:creator-device, Bundle.entry:creator-organization, Bundle.entry:requested-procedure | fullUrl cannot be a version specific reference |
fullUrl.contains('/_history/').not()
|
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value |
type = 'document' implies (identifier.system.exists() and identifier.value.exists())
|
| bdl-10 | error | Bundle | A document must have a date |
type = 'document' implies (timestamp.hasValue())
|
| bdl-11 | error | Bundle | A document must have a Composition as the first resource |
type = 'document' implies entry.first().resource.is(Composition)
|
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource |
type = 'message' implies entry.first().resource.is(MessageHeader)
|
| 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()
|
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| Bundle |
|
| identifier |
|
| timestamp |
|
| Slices for entry |
|
| entry:composition |
|
| entry:imaging-study |
|
| entry:patient |
|
| entry:wado-endpoint |
|
| entry:web-endpoint |
|
| entry:creator-device |
|
| entry:creator-organization |
|
| entry:requested-procedure |
|
| Documentation for this format | |
Summary
Mandatory: 10 elements(8 nested mandatory elements)
Prohibited: 27 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#0.2.1-build based on FHIR 4.0.1.
Generated
2026-09-16
