Manifest-based Access to DICOM Objects (MADO) Profile (FHIR-R5 elements)
0.2.0-ballot - ci-build
150
Manifest-based Access to DICOM Objects (MADO) Profile (FHIR-R5 elements), published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ballot 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-r5/StructureDefinition/ImManifestDocumentReference | Version: 0.2.0-ballot | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: ImManifestDocumentReference | ||
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License |
A DocumentReference profile for the Manifest DocumentReference used in MHD deployments.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2, im-docref-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | IheMhdEntryUUIDIdentifier | Business identifiers for the document |
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Imaging modality used Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (required) |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of Imaging Manifest Binding: HL7 EU Imaging Manifest Types (preferred) |
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: XDS Class Codes (preferred) |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who/what is the subject of the document |
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content |
![]() ![]() ![]() |
Σ | 0..* | CodeableReferenceWithRequiredCoding(BodyStructure) | The concept field is required for all bodySites. Slice: Unordered, Open by value:concept Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableReference(BodyStructure) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: Anatomical Region (required) |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Settings (preferred) |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that manages the Imaging Manifest | |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-manifest-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0040E031 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:value |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/dicom |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 113030 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/fhir+json |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical() | Code|uri|canonical Required Pattern: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImImagingStudyManifest |
![]() |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 From the FHIR Standard | |
DocumentReference.modality | required | https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.htmlhttps://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
DocumentReference.type | preferred | ImImagingManifestTypesEuVShttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/ImImagingManifestTypesEuVS From this IG | |
DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category From the FHIR Standard | |
DocumentReference.category:class-code | preferred | XdsClassCodeVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-xds-class-code-valueset From this IG | |
DocumentReference.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | |
DocumentReference.bodySite:anatomical-region | required | AnatomicalRegionVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-anatomical-region-valueset From this IG | |
DocumentReference.practiceSetting | preferred | PracticeSettingsVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-practice-settings From this IG | |
DocumentReference.custodian.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard | |
DocumentReference.custodian.identifier.type | extensible | Pattern Value: 0040E031http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
DocumentReference.content:kos.attachment.contentType | required | Pattern Value: application/dicomhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:kos.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x]:valueCoding | preferred | Pattern Value: 113030http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.attachment.contentType | required | Pattern Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:fhir.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.profile:fhir-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() | |
docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty() | |
docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty() | |
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() | |
im-docref-1 | error | DocumentReference | At least a KOS or FHIR manifest needs to be present. : content.value.subsumes( $dcm#113030) or content.value.endsWith('ImManifestDocumentReference') |
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: im-docref-1 |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
1..1 | IheMhdEntryUUIDIdentifier | Business identifiers for the document | |
![]() ![]() ![]() |
1..* | CodeableConcept | Imaging modality used Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (required) | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of Imaging Manifest Binding: HL7 EU Imaging Manifest Types (preferred) | |
![]() ![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Categorization of document Binding: XDS Class Codes (preferred) | |
![]() ![]() ![]() |
1..1 | Reference(Resource) | Who/what is the subject of the document | |
![]() ![]() ![]() |
0..* | CodeableReferenceWithRequiredCoding(BodyStructure) | The concept field is required for all bodySites. Slice: Unordered, Open by value:concept | |
![]() ![]() ![]() ![]() |
0..* | CodeableReference(BodyStructure) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: Anatomical Region (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Settings (preferred) | |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that manages the Imaging Manifest | |
![]() ![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-manifest-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0040E031 | |
![]() ![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:value | |
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: application/dicom | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found | |
![]() ![]() ![]() ![]() ![]() |
1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Content profile rules for the document | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding, uri, canonical() | Code|uri|canonical Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Code|uri|canonical Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 113030 | |
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: application/fhir+json | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found | |
![]() ![]() ![]() ![]() ![]() |
1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Content profile rules for the document | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding, uri, canonical() | Code|uri|canonical Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical() | Code|uri|canonical Required Pattern: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImImagingStudyManifest | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.modality | required | https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.htmlhttps://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
DocumentReference.type | preferred | ImImagingManifestTypesEuVShttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/ImImagingManifestTypesEuVS From this IG | |
DocumentReference.category:class-code | preferred | XdsClassCodeVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-xds-class-code-valueset From this IG | |
DocumentReference.bodySite:anatomical-region | required | AnatomicalRegionVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-anatomical-region-valueset From this IG | |
DocumentReference.practiceSetting | preferred | PracticeSettingsVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-practice-settings From this IG |
Id | Grade | Path(s) | Details | Requirements |
im-docref-1 | error | DocumentReference | At least a KOS or FHIR manifest needs to be present. : content.value.subsumes( $dcm#113030) or content.value.endsWith('ImManifestDocumentReference') |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2, im-docref-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | IheMhdEntryUUIDIdentifier | Business identifiers for the document | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | ||||
![]() ![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Imaging modality used Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of Imaging Manifest Binding: HL7 EU Imaging Manifest Types (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: XDS Class Codes (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() ![]() |
0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReferenceWithRequiredCoding(BodyStructure) | The concept field is required for all bodySites. Slice: Unordered, Open by value:concept Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableReference(BodyStructure) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: Anatomical Region (required) | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Settings (preferred) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Attests to accuracy of the document | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that manages the Imaging Manifest | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-manifest-r5/CodeSystem/codesystem-missing-dicom-terminology | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0040E031 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:value | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/dicom | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 113030 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/fhir+json | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical() | Code|uri|canonical Required Pattern: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImImagingStudyManifest | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 From the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 From the FHIR Standard | |
DocumentReference.modality | required | https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.htmlhttps://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
DocumentReference.type | preferred | ImImagingManifestTypesEuVShttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/ImImagingManifestTypesEuVS From this IG | |
DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category From the FHIR Standard | |
DocumentReference.category:class-code | preferred | XdsClassCodeVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-xds-class-code-valueset From this IG | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | |
DocumentReference.bodySite:anatomical-region | required | AnatomicalRegionVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-anatomical-region-valueset From this IG | |
DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | |
DocumentReference.practiceSetting | preferred | PracticeSettingsVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-practice-settings From this IG | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode From the FHIR Standard | |
DocumentReference.custodian.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | |
DocumentReference.custodian.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard | |
DocumentReference.custodian.identifier.type | extensible | Pattern Value: 0040E031http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type From the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples From the FHIR Standard | |
DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.attachment.contentType | required | Pattern Value: application/dicomhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:kos.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
DocumentReference.content:kos.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x]:valueCoding | preferred | Pattern Value: 113030http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.attachment.contentType | required | Pattern Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:fhir.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
DocumentReference.content:fhir.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.profile:fhir-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() | |
docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty() | |
docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty() | |
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() | |
im-docref-1 | error | DocumentReference | At least a KOS or FHIR manifest needs to be present. : content.value.subsumes( $dcm#113030) or content.value.endsWith('ImManifestDocumentReference') |
This structure is derived from DocumentReference
Summary
Mandatory: 6 elements(7 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2, im-docref-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system |
![]() ![]() ![]() ![]() |
Σ | 1..1 | IheMhdEntryUUIDIdentifier | Business identifiers for the document |
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Imaging modality used Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (required) |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of Imaging Manifest Binding: HL7 EU Imaging Manifest Types (preferred) |
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: XDS Class Codes (preferred) |
![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who/what is the subject of the document |
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content |
![]() ![]() ![]() |
Σ | 0..* | CodeableReferenceWithRequiredCoding(BodyStructure) | The concept field is required for all bodySites. Slice: Unordered, Open by value:concept Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableReference(BodyStructure) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: Anatomical Region (required) |
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Settings (preferred) |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that manages the Imaging Manifest | |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-manifest-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0040E031 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:value |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/dicom |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 113030 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/fhir+json |
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical() | Code|uri|canonical Required Pattern: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImImagingStudyManifest |
![]() |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 From the FHIR Standard | |
DocumentReference.modality | required | https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.htmlhttps://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
DocumentReference.type | preferred | ImImagingManifestTypesEuVShttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/ImImagingManifestTypesEuVS From this IG | |
DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category From the FHIR Standard | |
DocumentReference.category:class-code | preferred | XdsClassCodeVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-xds-class-code-valueset From this IG | |
DocumentReference.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | |
DocumentReference.bodySite:anatomical-region | required | AnatomicalRegionVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-anatomical-region-valueset From this IG | |
DocumentReference.practiceSetting | preferred | PracticeSettingsVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-practice-settings From this IG | |
DocumentReference.custodian.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard | |
DocumentReference.custodian.identifier.type | extensible | Pattern Value: 0040E031http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
DocumentReference.content:kos.attachment.contentType | required | Pattern Value: application/dicomhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:kos.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x]:valueCoding | preferred | Pattern Value: 113030http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.attachment.contentType | required | Pattern Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:fhir.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.profile:fhir-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() | |
docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty() | |
docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty() | |
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() | |
im-docref-1 | error | DocumentReference | At least a KOS or FHIR manifest needs to be present. : content.value.subsumes( $dcm#113030) or content.value.endsWith('ImManifestDocumentReference') |
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: im-docref-1 |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | |
![]() ![]() ![]() ![]() |
1..1 | IheMhdEntryUUIDIdentifier | Business identifiers for the document | |
![]() ![]() ![]() |
1..* | CodeableConcept | Imaging modality used Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (required) | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Type of Imaging Manifest Binding: HL7 EU Imaging Manifest Types (preferred) | |
![]() ![]() ![]() |
1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this | |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Categorization of document Binding: XDS Class Codes (preferred) | |
![]() ![]() ![]() |
1..1 | Reference(Resource) | Who/what is the subject of the document | |
![]() ![]() ![]() |
0..* | CodeableReferenceWithRequiredCoding(BodyStructure) | The concept field is required for all bodySites. Slice: Unordered, Open by value:concept | |
![]() ![]() ![]() ![]() |
0..* | CodeableReference(BodyStructure) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: Anatomical Region (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Settings (preferred) | |
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that manages the Imaging Manifest | |
![]() ![]() ![]() ![]() |
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Description of identifier Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-manifest-r5/CodeSystem/codesystem-missing-dicom-terminology | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0040E031 | |
![]() ![]() ![]() |
1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:value | |
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: application/dicom | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found | |
![]() ![]() ![]() ![]() ![]() |
1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Content profile rules for the document | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding, uri, canonical() | Code|uri|canonical Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Code|uri|canonical Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 113030 | |
![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Document referenced | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: application/fhir+json | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | url | Uri where the data can be found | |
![]() ![]() ![]() ![]() ![]() |
1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | BackboneElement | Content profile rules for the document | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Coding, uri, canonical() | Code|uri|canonical Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | canonical() | Code|uri|canonical Required Pattern: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImImagingStudyManifest | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.modality | required | https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.htmlhttps://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
DocumentReference.type | preferred | ImImagingManifestTypesEuVShttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/ImImagingManifestTypesEuVS From this IG | |
DocumentReference.category:class-code | preferred | XdsClassCodeVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-xds-class-code-valueset From this IG | |
DocumentReference.bodySite:anatomical-region | required | AnatomicalRegionVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-anatomical-region-valueset From this IG | |
DocumentReference.practiceSetting | preferred | PracticeSettingsVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-practice-settings From this IG |
Id | Grade | Path(s) | Details | Requirements |
im-docref-1 | error | DocumentReference | At least a KOS or FHIR manifest needs to be present. : content.value.subsumes( $dcm#113030) or content.value.endsWith('ImManifestDocumentReference') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | DocumentReference | A reference to a document Constraints: docRef-1, docRef-2, im-docref-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Business identifiers for the document Slice: Unordered, Open by value:system | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | IheMhdEntryUUIDIdentifier | Business identifiers for the document | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | ||||
![]() ![]() ![]() |
0..* | Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) | Procedure that caused this media to be created | |||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Imaging modality used Binding: https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Type of Imaging Manifest Binding: HL7 EU Imaging Manifest Types (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..* | CodeableConcept | Categorization of document Slice: Unordered, Open by value:$this Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Categorization of document Binding: XDS Class Codes (preferred) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
C | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() ![]() |
0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReferenceWithRequiredCoding(BodyStructure) | The concept field is required for all bodySites. Slice: Unordered, Open by value:concept Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableReference(BodyStructure) | The anatomical region of the patient that is the focus of the imaging manifest, concept field is required. Binding: Anatomical Region (required) | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() ![]() |
C | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: Practice Settings (preferred) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Attests to accuracy of the document | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that manages the Imaging Manifest | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.eu/fhir/imaging-manifest-r5/CodeSystem/codesystem-missing-dicom-terminology | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 0040E031 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced Slice: Unordered, Open by value:value | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/dicom | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 113030 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Required Pattern: application/fhir+json | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | integer64 | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Content profile rules for the document Slice: Unordered, Open by value:value | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Content profile rules for the document | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Code|uri|canonical Slice: Unordered, Open by type:$this Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | canonical() | Code|uri|canonical Required Pattern: http://hl7.eu/fhir/imaging-manifest-r5/StructureDefinition/ImImagingStudyManifest | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 From the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 From the FHIR Standard | |
DocumentReference.modality | required | https://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.htmlhttps://dicom.nema.org/medical/dicom/current/output/chtml/part16/sect_CID_29.html | |
DocumentReference.type | preferred | ImImagingManifestTypesEuVShttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/ImImagingManifestTypesEuVS From this IG | |
DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-category From the FHIR Standard | |
DocumentReference.category:class-code | preferred | XdsClassCodeVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-xds-class-code-valueset From this IG | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site From the FHIR Standard | |
DocumentReference.bodySite:anatomical-region | required | AnatomicalRegionVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-anatomical-region-valueset From this IG | |
DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | |
DocumentReference.practiceSetting | preferred | PracticeSettingsVshttp://hl7.eu/fhir/imaging-manifest-r5/ValueSet/im-practice-settings From this IG | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode From the FHIR Standard | |
DocumentReference.custodian.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard | |
DocumentReference.custodian.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard | |
DocumentReference.custodian.identifier.type | extensible | Pattern Value: 0040E031http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type From the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples From the FHIR Standard | |
DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.attachment.contentType | required | Pattern Value: application/dicomhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:kos.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
DocumentReference.content:kos.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:kos.profile:kos-manifest.value[x]:valueCoding | preferred | Pattern Value: 113030http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.attachment.contentType | required | Pattern Value: application/fhir+jsonhttp://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard | |
DocumentReference.content:fhir.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
DocumentReference.content:fhir.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes | |
DocumentReference.content:fhir.profile:fhir-manifest.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
Id | Grade | Path(s) | Details | Requirements |
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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() | |
docRef-1 | warning | DocumentReference | facilityType SHALL only be present if context is not an encounter : facilityType.empty() or context.where(resolve() is Encounter).empty() | |
docRef-2 | warning | DocumentReference | practiceSetting SHALL only be present if context is not present : practiceSetting.empty() or context.where(resolve() is Encounter).empty() | |
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() | |
im-docref-1 | error | DocumentReference | At least a KOS or FHIR manifest needs to be present. : content.value.subsumes( $dcm#113030) or content.value.endsWith('ImManifestDocumentReference') |
This structure is derived from DocumentReference
Summary
Mandatory: 6 elements(7 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron