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/EuMadoDicomKosDocumentReference | Version: 0.2.1-build | ||||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EuMadoDicomKosDocumentReference | |||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
MADO specific profile for the IHE-MHD Document Reference for MADO DICOM KOS Manifests that includes the MADO specific content format.
|
This profile must be updated once the cross-version extension issue has been resolved: the R5 → R4 backport extensions it relies on (e.g. anatomical region / bodySite) were removed from the cross-version extensions package in release 0.1.0 and need to be re-introduced. Tracked in FHIR-58654. |
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:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  DocumentReference |
C | 0..* | MadoDicomKosDocumentReference | A reference to a document Constraints: mado-docref-1 | ||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
  Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
   extension:bodysite |
SO | 1..* | (Complex) | Extension: DocumentReference.bodySite URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
| ||||||||
  extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||||||
  value[x] |
0..1 | CodeableConcept | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: ValueSet: Anatomical Region (required) | |||||||||
 extension:modality |
SO | 1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
| ||||||||
| masterIdentifier |
Σ | 1..1 | UniqueIdIdentifier | The SOP Instance UID of the DICOM KOS manifest. | ||||||||
 Slices for identifier |
SOΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use
| ||||||||
| identifier:entryUUID |
SOΣ | 0..* | EntryUUIDIdentifier | Other identifiers for the document
| ||||||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | ||||||||
| type |
SOΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18748-4 | |||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||
 userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||
| category |
SOΣ | 1..1 | 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 |
SOΣ | 1..1 | Reference(EU MADO Patient) | Who/what is the subject of the document
| ||||||||
| date |
SOΣ | 0..1 | instant | When this document reference was created
| ||||||||
| Slices for author |
SOΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve()
| ||||||||
 author:source-organization |
SOΣ | 0..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| ||||||||
| author:source-device |
SOΣ | 0..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| ||||||||
| Slices for relatesTo |
SOΣ | 0..* | BackboneElement | Relationships to other documents Slice: Unordered, Open by value:code
| ||||||||
 relatesTo:All Slices |
Content/Rules for all slices | |||||||||||
 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 |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||||||
 relatesTo:fhir-reference |
SOΣ | 0..1 | BackboneElement | Reference to the DocumentReference resource that contains the FHIR Imaging Study Manifest that corresponds to this imaging manifest in DICOM KOS format
| ||||||||
 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. Required Pattern: transforms | ||||||||
| target |
Σ | 1..1 | Reference(MADO MHD DocumentReference Profile for FHIR Imaging Study Manifest) | Target of the relationship | ||||||||
| securityLabel |
SOΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
| ||||||||
| content |
Σ | 1..1 | BackboneElement | Clinical context of the manifest | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document | ||||||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/dicom | ||||||||
| language |
SOΣ | 1..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU
| ||||||||
| url |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||
| creation |
SOΣ | 1..1 | dateTime | Date attachment was first created
| ||||||||
 format |
SOΣ | 0..1 | Coding | Format/content rules for the document Binding: IHE_FormatCode_vs (1.5.0) (preferred) Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCMUID | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1.2.840.10008.5.1.4.1.1.88.59 | |||||||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Key Object Selection Document | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| context |
SOΣ | 1..1 | BackboneElement | Clinical context of document
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| period |
SOΣ | 1..1 | Period | Time of service that is being documented
| ||||||||
| start |
ΣC | 1..1 | dateTime | The start time of the study referred to by the manifest | ||||||||
| facilityType |
SO | 1..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
| ||||||||
| practiceSetting |
SO | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
| ||||||||
| sourcePatientInfo |
SO | 0..1 | Reference(Patient) | Patient demographics from source
| ||||||||
| Slices for related |
1..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by profile:identifier | |||||||||
| related:study-instance-uid |
S | 1..1 | MadoReferencedStudyInstanceUidIdentifier(Resource) | The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID. | ||||||||
| related:accession-number |
S | 0..1 | MadoReferencedAccessionNumberIdentifier(Resource) | The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number. | ||||||||
| Documentation for this format | ||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| Slices for relatesTo |
|
| relatesTo:All Slices |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Slices for related |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | required | ValueSet: Anatomical Region | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | Document Type Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo:fhir-reference.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📍1.5.0 | IHE FormatCode Vocabulary v1.5 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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()
|
| mado-docref-1 | error | DocumentReference | masterIdentifier, when used, need to be present as an identifier as well |
masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | MadoDicomKosDocumentReference | A reference to a document | |||||
| extension |
2..* | Extension | Extension | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:bodysite |
O | 1..* | MadoDocumentReferenceBodySite | Extension: DocumentReference.bodySite
| ||||
| value[x] |
0..1 | CodeableConcept | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: ValueSet: Anatomical Region (required) | |||||
| extension:modality |
O | 1..* | MadoDocumentReferenceModality | Extension: DocumentReference.modality (R5 cross-version)
| ||||
| identifier |
O | 1..* | Identifier | Other identifiers for the document
| ||||
| Slices for identifier |
Content/Rules for all slices | |||||||
| identifier:entryUUID |
O | 0..* | EntryUUIDIdentifier | Other identifiers for the document
| ||||
| type |
O | 1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Required Pattern: At least the following
| ||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18748-4 | |||||
| category |
O | 1..1 | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3.
| ||||
| subject |
O | 1..1 | Reference(EU MADO Patient) | Who/what is the subject of the document
| ||||
| date |
O | 0..1 | instant | When this document reference was created
| ||||
| author |
O | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document (i.e. manifest)
| ||||
| Slices for author |
Content/Rules for all slices | |||||||
| author:source-organization |
O | 0..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| ||||
| author:source-device |
O | 0..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| ||||
| relatesTo |
O | 0..* | BackboneElement | Relationships to other documents
| ||||
| Slices for relatesTo |
Content/Rules for all slices | |||||||
| relatesTo:fhir-reference |
O | 0..1 | BackboneElement | Reference to the DocumentReference resource that contains the FHIR Imaging Study Manifest that corresponds to this imaging manifest in DICOM KOS format
| ||||
| securityLabel |
O | 0..* | CodeableConcept | Document security-tags
| ||||
| content |
||||||||
| attachment |
||||||||
| language |
O | 1..1 | code | Human language of the content (BCP-47)
| ||||
| creation |
O | 1..1 | dateTime | Date attachment was first created
| ||||
| format |
O | 0..1 | Coding | Format/content rules for the document
| ||||
| context |
SO | 1..1 | BackboneElement | Clinical context of document
| ||||
| period |
O | 1..1 | Period | Time of service that is being documented
| ||||
| facilityType |
O | 1..1 | CodeableConcept | Kind of facility where patient was seen
| ||||
| practiceSetting |
O | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty)
| ||||
| sourcePatientInfo |
O | 0..1 | Reference(Patient) | Patient demographics from source
| ||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| identifier |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| author |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| relatesTo |
|
| Slices for relatesTo |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | required | ValueSet: Anatomical Region | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | MadoDicomKosDocumentReference | A reference to a document Constraints: mado-docref-1 | ||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||||
| 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 |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:bodysite |
SO | 1..* | (Complex) | Extension: DocumentReference.bodySite URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||||||
| value[x] |
0..1 | CodeableConcept | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:modality |
SO | 1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
| ||||||||
| masterIdentifier |
Σ | 1..1 | UniqueIdIdentifier | The SOP Instance UID of the DICOM KOS manifest. | ||||||||
| Slices for identifier |
SOΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use
| ||||||||
| identifier:entryUUID |
SOΣ | 0..* | EntryUUIDIdentifier | Other identifiers for the document
| ||||||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | ||||||||
| type |
SOΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18748-4 | |||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||
| category |
SOΣ | 1..1 | 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 |
SOΣ | 1..1 | Reference(EU MADO Patient) | Who/what is the subject of the document
| ||||||||
| date |
SOΣ | 0..1 | instant | When this document reference was created
| ||||||||
| Slices for author |
SOΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve()
| ||||||||
| author:source-organization |
SOΣ | 0..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| ||||||||
| author:source-device |
SOΣ | 0..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| ||||||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document (i.e. manifest) | |||||||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the document (i.e. manifest) | |||||||||
| Slices for relatesTo |
SOΣ | 0..* | BackboneElement | Relationships to other documents Slice: Unordered, Open by value:code
| ||||||||
| relatesTo: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 |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||||||
| target |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||||||
| relatesTo:fhir-reference |
SOΣ | 0..1 | BackboneElement | Reference to the DocumentReference resource that contains the FHIR Imaging Study Manifest that corresponds to this imaging manifest in DICOM KOS format
| ||||||||
| 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. Required Pattern: transforms | ||||||||
| target |
Σ | 1..1 | Reference(MADO MHD DocumentReference Profile for FHIR Imaging Study Manifest) | Target of the relationship | ||||||||
| description |
Σ | 0..1 | string | Human-readable description | ||||||||
| securityLabel |
SOΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
| ||||||||
| content |
Σ | 1..1 | BackboneElement | Clinical context of the manifest | ||||||||
| 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 | ||||||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/dicom | ||||||||
| language |
SOΣ | 1..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU
| ||||||||
| url |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||||||
| creation |
SOΣ | 1..1 | dateTime | Date attachment was first created
| ||||||||
| format |
SOΣ | 0..1 | Coding | Format/content rules for the document Binding: IHE_FormatCode_vs (1.5.0) (preferred) Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCMUID | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1.2.840.10008.5.1.4.1.1.88.59 | |||||||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Key Object Selection Document | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| context |
SOΣ | 1..1 | BackboneElement | Clinical context of document
| ||||||||
| 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 | ||||||||
| encounter |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||||||
| event |
0..* | CodeableConcept | Main clinical acts documented, could include the study procedure codes. Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||
| period |
SOΣ | 1..1 | Period | Time of service that is being documented
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
ΣC | 1..1 | dateTime | The start time of the study referred to by the manifest | ||||||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| facilityType |
SO | 1..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
| ||||||||
| practiceSetting |
SO | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
| ||||||||
| sourcePatientInfo |
SO | 0..1 | Reference(Patient) | Patient demographics from source
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| Slices for related |
1..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by profile:identifier | |||||||||
| related:study-instance-uid |
S | 1..1 | MadoReferencedStudyInstanceUidIdentifier(Resource) | The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID. | ||||||||
| related:accession-number |
S | 0..1 | MadoReferencedAccessionNumberIdentifier(Resource) | The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number. | ||||||||
| Documentation for this format | ||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| Slices for relatesTo |
|
| relatesTo:All Slices |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Slices for related |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.extension:bodysite.value[x] | Base | required | ValueSet: Anatomical Region | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | Document Type Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo:fhir-reference.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📍1.5.0 | IHE FormatCode Vocabulary v1.5 |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.3 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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()
|
| mado-docref-1 | error | DocumentReference | masterIdentifier, when used, need to be present as an identifier as well |
masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()
|
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| Slices for relatesTo |
|
| relatesTo:All Slices |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Slices for related |
|
| Documentation for this format | |
Summary
Mandatory: 1 element
Must-Support: 1 element
Structures
This structure refers to these other structures:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | MadoDicomKosDocumentReference | A reference to a document Constraints: mado-docref-1 | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:bodysite |
SO | 1..* | (Complex) | Extension: DocumentReference.bodySite URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
| ||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||||||
| value[x] |
0..1 | CodeableConcept | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:modality |
SO | 1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
| ||||||||
| masterIdentifier |
Σ | 1..1 | UniqueIdIdentifier | The SOP Instance UID of the DICOM KOS manifest. | ||||||||
| Slices for identifier |
SOΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use
| ||||||||
| identifier:entryUUID |
SOΣ | 0..* | EntryUUIDIdentifier | Other identifiers for the document
| ||||||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | ||||||||
| type |
SOΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18748-4 | |||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||
| category |
SOΣ | 1..1 | 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 |
SOΣ | 1..1 | Reference(EU MADO Patient) | Who/what is the subject of the document
| ||||||||
| date |
SOΣ | 0..1 | instant | When this document reference was created
| ||||||||
| Slices for author |
SOΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve()
| ||||||||
| author:source-organization |
SOΣ | 0..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| ||||||||
| author:source-device |
SOΣ | 0..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| ||||||||
| Slices for relatesTo |
SOΣ | 0..* | BackboneElement | Relationships to other documents Slice: Unordered, Open by value:code
| ||||||||
| relatesTo:All Slices |
Content/Rules for all slices | |||||||||||
| 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 |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||||||
| relatesTo:fhir-reference |
SOΣ | 0..1 | BackboneElement | Reference to the DocumentReference resource that contains the FHIR Imaging Study Manifest that corresponds to this imaging manifest in DICOM KOS format
| ||||||||
| 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. Required Pattern: transforms | ||||||||
| target |
Σ | 1..1 | Reference(MADO MHD DocumentReference Profile for FHIR Imaging Study Manifest) | Target of the relationship | ||||||||
| securityLabel |
SOΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
| ||||||||
| content |
Σ | 1..1 | BackboneElement | Clinical context of the manifest | ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document | ||||||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/dicom | ||||||||
| language |
SOΣ | 1..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU
| ||||||||
| url |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||
| creation |
SOΣ | 1..1 | dateTime | Date attachment was first created
| ||||||||
| format |
SOΣ | 0..1 | Coding | Format/content rules for the document Binding: IHE_FormatCode_vs (1.5.0) (preferred) Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCMUID | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1.2.840.10008.5.1.4.1.1.88.59 | |||||||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Key Object Selection Document | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| context |
SOΣ | 1..1 | BackboneElement | Clinical context of document
| ||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||
| period |
SOΣ | 1..1 | Period | Time of service that is being documented
| ||||||||
| start |
ΣC | 1..1 | dateTime | The start time of the study referred to by the manifest | ||||||||
| facilityType |
SO | 1..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
| ||||||||
| practiceSetting |
SO | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
| ||||||||
| sourcePatientInfo |
SO | 0..1 | Reference(Patient) | Patient demographics from source
| ||||||||
| Slices for related |
1..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by profile:identifier | |||||||||
| related:study-instance-uid |
S | 1..1 | MadoReferencedStudyInstanceUidIdentifier(Resource) | The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID. | ||||||||
| related:accession-number |
S | 0..1 | MadoReferencedAccessionNumberIdentifier(Resource) | The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number. | ||||||||
| Documentation for this format | ||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| Slices for relatesTo |
|
| relatesTo:All Slices |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Slices for related |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | required | ValueSet: Anatomical Region | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | Document Type Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo:fhir-reference.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📍1.5.0 | IHE FormatCode Vocabulary v1.5 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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()
|
| mado-docref-1 | error | DocumentReference | masterIdentifier, when used, need to be present as an identifier as well |
masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | MadoDicomKosDocumentReference | A reference to a document | |||||
| extension |
2..* | Extension | Extension | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:bodysite |
O | 1..* | MadoDocumentReferenceBodySite | Extension: DocumentReference.bodySite
| ||||
| value[x] |
0..1 | CodeableConcept | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: ValueSet: Anatomical Region (required) | |||||
| extension:modality |
O | 1..* | MadoDocumentReferenceModality | Extension: DocumentReference.modality (R5 cross-version)
| ||||
| identifier |
O | 1..* | Identifier | Other identifiers for the document
| ||||
| Slices for identifier |
Content/Rules for all slices | |||||||
| identifier:entryUUID |
O | 0..* | EntryUUIDIdentifier | Other identifiers for the document
| ||||
| type |
O | 1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Required Pattern: At least the following
| ||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18748-4 | |||||
| category |
O | 1..1 | CodeableConcept | Categorization of document, see section 6.X.6 of volume 3.
| ||||
| subject |
O | 1..1 | Reference(EU MADO Patient) | Who/what is the subject of the document
| ||||
| date |
O | 0..1 | instant | When this document reference was created
| ||||
| author |
O | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document (i.e. manifest)
| ||||
| Slices for author |
Content/Rules for all slices | |||||||
| author:source-organization |
O | 0..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| ||||
| author:source-device |
O | 0..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| ||||
| relatesTo |
O | 0..* | BackboneElement | Relationships to other documents
| ||||
| Slices for relatesTo |
Content/Rules for all slices | |||||||
| relatesTo:fhir-reference |
O | 0..1 | BackboneElement | Reference to the DocumentReference resource that contains the FHIR Imaging Study Manifest that corresponds to this imaging manifest in DICOM KOS format
| ||||
| securityLabel |
O | 0..* | CodeableConcept | Document security-tags
| ||||
| content |
||||||||
| attachment |
||||||||
| language |
O | 1..1 | code | Human language of the content (BCP-47)
| ||||
| creation |
O | 1..1 | dateTime | Date attachment was first created
| ||||
| format |
O | 0..1 | Coding | Format/content rules for the document
| ||||
| context |
SO | 1..1 | BackboneElement | Clinical context of document
| ||||
| period |
O | 1..1 | Period | Time of service that is being documented
| ||||
| facilityType |
O | 1..1 | CodeableConcept | Kind of facility where patient was seen
| ||||
| practiceSetting |
O | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty)
| ||||
| sourcePatientInfo |
O | 0..1 | Reference(Patient) | Patient demographics from source
| ||||
| Documentation for this format | ||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| identifier |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| author |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| relatesTo |
|
| Slices for relatesTo |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.extension:bodysite.value[x] | Base | required | ValueSet: Anatomical Region | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference |
C | 0..* | MadoDicomKosDocumentReference | A reference to a document Constraints: mado-docref-1 | ||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||||
| 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 |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:bodysite |
SO | 1..* | (Complex) | Extension: DocumentReference.bodySite URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||||||
| url |
1..1 | uri | "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite" | |||||||||
| value[x] |
0..1 | CodeableConcept | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: ValueSet: Anatomical Region (required) | |||||||||
| extension:modality |
SO | 1..* | CodeableConcept | Extension: DocumentReference.modality (R5 cross-version) URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
| ||||||||
| masterIdentifier |
Σ | 1..1 | UniqueIdIdentifier | The SOP Instance UID of the DICOM KOS manifest. | ||||||||
| Slices for identifier |
SOΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use
| ||||||||
| identifier:entryUUID |
SOΣ | 0..* | EntryUUIDIdentifier | Other identifiers for the document
| ||||||||
| status |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: MHD DocumentReference status codes (required) | ||||||||
| type |
SOΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible), see section 6.X.6 of volume 3. Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 18748-4 | |||||||||
| display |
0..1 | string | Representation defined by the system | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| text |
0..1 | string | Plain text representation of the concept | |||||||||
| category |
SOΣ | 1..1 | 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 |
SOΣ | 1..1 | Reference(EU MADO Patient) | Who/what is the subject of the document
| ||||||||
| date |
SOΣ | 0..1 | instant | When this document reference was created
| ||||||||
| Slices for author |
SOΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document (i.e. manifest) Slice: Unordered, Open by profile:$this.resolve()
| ||||||||
| author:source-organization |
SOΣ | 0..1 | Reference(EU MADO Creator Organization) | The organization that generated the manifest.
| ||||||||
| author:source-device |
SOΣ | 0..1 | Reference(EU MADO Creator) | The device that generated the manifest.
| ||||||||
| authenticator |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document (i.e. manifest) | |||||||||
| custodian |
0..1 | Reference(Organization) | Organization which maintains the document (i.e. manifest) | |||||||||
| Slices for relatesTo |
SOΣ | 0..* | BackboneElement | Relationships to other documents Slice: Unordered, Open by value:code
| ||||||||
| relatesTo: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 |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||||||
| target |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||||||
| relatesTo:fhir-reference |
SOΣ | 0..1 | BackboneElement | Reference to the DocumentReference resource that contains the FHIR Imaging Study Manifest that corresponds to this imaging manifest in DICOM KOS format
| ||||||||
| 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. Required Pattern: transforms | ||||||||
| target |
Σ | 1..1 | Reference(MADO MHD DocumentReference Profile for FHIR Imaging Study Manifest) | Target of the relationship | ||||||||
| description |
Σ | 0..1 | string | Human-readable description | ||||||||
| securityLabel |
SOΣ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
| ||||||||
| content |
Σ | 1..1 | BackboneElement | Clinical context of the manifest | ||||||||
| 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 | ||||||||
| attachment |
Σ | 1..1 | Attachment | Where to access the document | ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| contentType |
Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/dicom | ||||||||
| language |
SOΣ | 1..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU
| ||||||||
| url |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||||||
| size |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||||||
| hash |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||||||
| title |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||||||
| creation |
SOΣ | 1..1 | dateTime | Date attachment was first created
| ||||||||
| format |
SOΣ | 0..1 | Coding | Format/content rules for the document Binding: IHE_FormatCode_vs (1.5.0) (preferred) Required Pattern: At least the following
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCMUID | |||||||||
| version |
0..1 | string | Version of the system - if relevant | |||||||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 1.2.840.10008.5.1.4.1.1.88.59 | |||||||||
| display |
1..1 | string | Representation defined by the system Fixed Value: Key Object Selection Document | |||||||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||||||
| context |
SOΣ | 1..1 | BackboneElement | Clinical context of document
| ||||||||
| 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 | ||||||||
| encounter |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||||||
| event |
0..* | CodeableConcept | Main clinical acts documented, could include the study procedure codes. Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||||||
| period |
SOΣ | 1..1 | Period | Time of service that is being documented
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
ΣC | 1..1 | dateTime | The start time of the study referred to by the manifest | ||||||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| facilityType |
SO | 1..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
| ||||||||
| practiceSetting |
SO | 1..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
| ||||||||
| sourcePatientInfo |
SO | 0..1 | Reference(Patient) | Patient demographics from source
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| reference |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| Slices for related |
1..* | Reference(Resource) | Related identifiers or resources Slice: Unordered, Open by profile:identifier | |||||||||
| related:study-instance-uid |
S | 1..1 | MadoReferencedStudyInstanceUidIdentifier(Resource) | The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID. | ||||||||
| related:accession-number |
S | 0..1 | MadoReferencedAccessionNumberIdentifier(Resource) | The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number. | ||||||||
| Documentation for this format | ||||||||||||
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| Slices for relatesTo |
|
| relatesTo:All Slices |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Slices for related |
|
| Documentation for this format | |
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.extension:bodysite.value[x] | Base | required | ValueSet: Anatomical Region | 📦1.0.0 | Manifest-based Access to DICOM Objects v1.0 |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | preferred | Document Type Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | example | Document Class Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.relatesTo:fhir-reference.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📍1.5.0 | IHE FormatCode Vocabulary v1.5 |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.3 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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()
|
| mado-docref-1 | error | DocumentReference | masterIdentifier, when used, need to be present as an identifier as well |
masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()
|
| Name | Content Creator/Document Source (Imaging Manifest) |
|---|---|
| DocumentReference |
|
| Slices for extension |
|
| extension:bodysite |
|
| extension:modality |
|
| Slices for identifier |
|
| identifier:entryUUID |
|
| type |
|
| category |
|
| subject |
|
| date |
|
| Slices for author |
|
| author:source-organization |
|
| author:source-device |
|
| Slices for relatesTo |
|
| relatesTo:All Slices |
|
| relatesTo:fhir-reference |
|
| securityLabel |
|
| content |
|
| attachment |
|
| language |
|
| creation |
|
| format |
|
| context |
|
| period |
|
| facilityType |
|
| practiceSetting |
|
| sourcePatientInfo |
|
| Slices for related |
|
| Documentation for this format | |
Summary
Mandatory: 1 element
Must-Support: 1 element
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
