EU Imaging Manifest and Access (IHE-MADO additions)
1.0.0-ballot - ballot 150

This page is part of the EU Manifest-based Access to DICOM Objects (EU-MADO) (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: EU MADO MHD DocumentReference Profile for FHIR Imaging Study Manifest

Official URL: http://hl7.eu/fhir/imaging-manifest/StructureDefinition/EuMadoFhirDocumentReference Version: 1.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: EuMadoFhirDocumentReference

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

EU MADO profile for the IHE-MHD Document Reference for FHIR Imaging Study Manifest.

This profile must be updated once the cross-version extension issue has been resolved: the R5 → R4 backport extensions it relies on (e.g. anatomical region / bodySite) were removed from the cross-version extensions package in release 0.1.0 and need to be re-introduced. Tracked in FHIR-58654.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference C 0..* MadoFhirDocumentReference A reference to a document
Constraints: mado-docref-1
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for extension.extension:bodysite This element has obligations and must be supported. 1..* (Complex) Extension: DocumentReference.bodySite
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for extension.extension:bodysite.extension 0..0 Extension
Slice: Unordered, Open by value:url
DocumentReference.Slices for extension.extension:bodysite.url 1..1 uri "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite"
DocumentReference.Slices for extension.extension:bodysite.value[x] 0..1 CodeableConcept The anatomical region of the patient that is the focus of the imaging manifest, concept field is required.
Binding: ValueSet: Anatomical Region (required)
DocumentReference.Slices for extension.extension:modality This element has obligations and must be supported. 1..* CodeableConcept Extension: DocumentReference.modality (R5 cross-version)
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The identifier of the FHIR Imaging Study Manifest.
DocumentReference.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:entryUUID This element has obligations and must be supported. This element is included in summaries. 0..* EntryUUIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Other identifiers for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
DocumentReference.type This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible), see section 6.X.6 of volume 3.
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "18748-4"
    }
  ]
}
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.category This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Categorization of document, see section 6.X.6 of volume 3.
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO Patient) Who/what is the subject of the document
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.date This element has obligations and must be supported. This element is included in summaries. 0..1 instant When this document reference was created
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author This element has obligations and must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document (i.e. manifest)
Slice: Unordered, Open by profile:$this.resolve()
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for author.author:source-organization This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator Organization) The organization that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author.author:source-device This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator) The device that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
DocumentReference.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:All Slices.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.Slices for relatesTo.relatesTo:All Slices.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.Slices for relatesTo.relatesTo:kos-reference This element has obligations and must be supported. This element is included in summaries. 0..1 BackboneElement Reference to the DocumentReference resource that contains the DICOM KOS manifest that corresponds to this imaging manifest in FHIR format
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Required Pattern: transforms (extensions allowed)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.target This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests) Target of the relationship
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.securityLabel This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ObligationsActor
MAY:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Clinical context of the manifest
DocumentReference.content.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
DocumentReference.content.Slices for extension.extension:profile 1..* (Complex) Contains the profile of the referred report
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value 1..1 Extension Extension
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.url 1..1 uri "value"
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] 1..1 Code|uri|canonical
Slice: Unordered, Open by type:$this
Binding: R5V3HL7FormatCodesForR4 (0.1.0) (preferred): Document Format Codes.
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCoding Coding
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueUri uri
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCanonical canonical(Any)
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].value[x]:valueCanonical 0..1 canonical() Code|uri|canonical
Required Pattern: https://profiles.ihe.net/RAD/MADO/StructureDefinition/MadoFhirBundle (extensions allowed)
DocumentReference.content.Slices for extension.extension:profile.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile"
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/fhir+json (extensions allowed)
DocumentReference.content.attachment.language This element has obligations and must be supported. This element is included in summaries. 1..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.attachment.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.creation This element has obligations and must be supported. This element is included in summaries. 1..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format This element has obligations and must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE_FormatCode_vs (1.5.0) (preferred)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode (no extensions allowed)
DocumentReference.content.format.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Fixed Value: urn:ihe:rad:MADO:fhir-manifest:2026 (no extensions allowed)
DocumentReference.context This element has obligations and must be supported. This element is included in summaries. 1..1 BackboneElement Clinical context of document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.period This element has obligations and must be supported. This element is included in summaries. 1..1 Period Time of service that is being documented
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.period.start This element is included in summaries. C 1..1 dateTime The start time of the study referred to by the manifest
DocumentReference.context.facilityType This element has obligations and must be supported. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.practiceSetting This element has obligations and must be supported. 1..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo This element has obligations and must be supported. 0..1 Reference(Patient) Patient demographics from source
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by profile:identifier
DocumentReference.context.Slices for related.related:study-instance-uid This element must be supported. 1..1 MadoReferencedStudyInstanceUidIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID.
DocumentReference.context.Slices for related.related:accession-number This element must be supported. 0..1 MadoReferencedAccessionNumberIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number.

doco Documentation for this format
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / Slices for extension
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo
DocumentReference / context / Slices for related

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.extension:bodysite.​value[x] Base required ValueSet: Anatomical Region 📦1.0.0 Manifest-based Access to DICOM Objects v1.0
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo:kos-reference.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​extension:profile.extension:value.​value[x] Base preferred Cross-version ValueSet R5.HL7FormatCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📍1.5.0 IHE FormatCode Vocabulary v1.5
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mado-docref-1 error DocumentReference masterIdentifier, when used, need to be present as an identifier as well masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()

This structure is derived from MadoFhirDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* MadoFhirDocumentReference A reference to a document
DocumentReference.extension 2..* Extension Extension
DocumentReference.Slices for extension Content/Rules for all slices
DocumentReference.Slices for extension.extension:bodysite This element has obligations. 1..* MadoDocumentReferenceBodySite Extension: DocumentReference.bodySite
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for extension.extension:bodysite.value[x] 0..1 CodeableConcept The anatomical region of the patient that is the focus of the imaging manifest, concept field is required.
Binding: ValueSet: Anatomical Region (required)
DocumentReference.Slices for extension.extension:modality This element has obligations. 1..* MadoDocumentReferenceModality Extension: DocumentReference.modality (R5 cross-version)
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.identifier This element has obligations. 1..* Identifier Other identifiers for the document
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for identifier.identifier:entryUUID This element has obligations. 0..* EntryUUIDIdentifier Other identifiers for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.type This element has obligations. 1..1 CodeableConcept Kind of document (LOINC if possible), see section 6.X.6 of volume 3.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "18748-4"
    }
  ]
}
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.category This element has obligations. 1..1 CodeableConcept Categorization of document, see section 6.X.6 of volume 3.
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.subject This element has obligations. 1..1 Reference(EU MADO Patient) Who/what is the subject of the document
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.date This element has obligations. 0..1 instant When this document reference was created
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.author This element has obligations. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document (i.e. manifest)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author Content/Rules for all slices
DocumentReference.Slices for author.author:source-organization This element has obligations. 0..1 Reference(EU MADO Creator Organization) The organization that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author.author:source-device This element has obligations. 0..1 Reference(EU MADO Creator) The device that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo Content/Rules for all slices
DocumentReference.Slices for relatesTo.relatesTo:kos-reference This element has obligations. 0..1 BackboneElement Reference to the DocumentReference resource that contains the DICOM KOS manifest that corresponds to this imaging manifest in FHIR format
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.target This element has obligations and must be supported. 1..1 Reference(EU MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests) Target of the relationship
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.securityLabel This element has obligations. 0..* CodeableConcept Document security-tags
ObligationsActor
MAY:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content
DocumentReference.content.attachment
DocumentReference.content.attachment.language This element has obligations. 1..1 code Human language of the content (BCP-47)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.attachment.creation This element has obligations. 1..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format This element has obligations. 1..1 Coding Format/content rules for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context This element has obligations and must be supported. 1..1 BackboneElement Clinical context of document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.period This element has obligations. 1..1 Period Time of service that is being documented
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.facilityType This element has obligations. 1..1 CodeableConcept Kind of facility where patient was seen
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.practiceSetting This element has obligations. 1..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo This element has obligations. 0..1 Reference(Patient) Patient demographics from source
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)

doco Documentation for this format
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / identifier
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / author
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.extension:bodysite.​value[x] Base required ValueSet: Anatomical Region 📦1.0.0 Manifest-based Access to DICOM Objects v1.0
NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference C 0..* MadoFhirDocumentReference A reference to a document
Constraints: mado-docref-1
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.meta.id 0..1 string Unique id for inter-element referencing
DocumentReference.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
DocumentReference.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
DocumentReference.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
DocumentReference.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
DocumentReference.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for extension.extension:bodysite This element has obligations and must be supported. 1..* (Complex) Extension: DocumentReference.bodySite
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for extension.extension:bodysite.id 0..1 string Unique id for inter-element referencing
DocumentReference.Slices for extension.extension:bodysite.extension 0..0 Extension
Slice: Unordered, Open by value:url
DocumentReference.Slices for extension.extension:bodysite.url 1..1 uri "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite"
DocumentReference.Slices for extension.extension:bodysite.value[x] 0..1 CodeableConcept The anatomical region of the patient that is the focus of the imaging manifest, concept field is required.
Binding: ValueSet: Anatomical Region (required)
DocumentReference.Slices for extension.extension:modality This element has obligations and must be supported. 1..* CodeableConcept Extension: DocumentReference.modality (R5 cross-version)
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The identifier of the FHIR Imaging Study Manifest.
DocumentReference.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:entryUUID This element has obligations and must be supported. This element is included in summaries. 0..* EntryUUIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Other identifiers for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
DocumentReference.type This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible), see section 6.X.6 of volume 3.
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "18748-4"
    }
  ]
}
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.category This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Categorization of document, see section 6.X.6 of volume 3.
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO Patient) Who/what is the subject of the document
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.date This element has obligations and must be supported. This element is included in summaries. 0..1 instant When this document reference was created
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author This element has obligations and must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document (i.e. manifest)
Slice: Unordered, Open by profile:$this.resolve()
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for author.author:source-organization This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator Organization) The organization that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author.author:source-device This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator) The device that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document (i.e. manifest)
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document (i.e. manifest)
DocumentReference.Slices for relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
DocumentReference.Slices for relatesTo.relatesTo:All Slices.id 0..1 string Unique id for inter-element referencing
DocumentReference.Slices for relatesTo.relatesTo:All Slices.extension 0..* Extension Additional content defined by implementations
DocumentReference.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:All Slices.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.Slices for relatesTo.relatesTo:All Slices.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.Slices for relatesTo.relatesTo:kos-reference This element has obligations and must be supported. This element is included in summaries. 0..1 BackboneElement Reference to the DocumentReference resource that contains the DICOM KOS manifest that corresponds to this imaging manifest in FHIR format
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.id 0..1 string Unique id for inter-element referencing
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.extension 0..* Extension Additional content defined by implementations
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Required Pattern: transforms (extensions allowed)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.target This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests) Target of the relationship
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ObligationsActor
MAY:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Clinical context of the manifest
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
DocumentReference.content.Slices for extension.extension:profile 1..* (Complex) Contains the profile of the referred report
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.Slices for extension.extension:profile.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value 1..1 Extension Extension
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.url 1..1 uri "value"
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] 1..1 Code|uri|canonical
Slice: Unordered, Open by type:$this
Binding: R5V3HL7FormatCodesForR4 (0.1.0) (preferred): Document Format Codes.
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCoding Coding
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueUri uri
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCanonical canonical(Any)
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].value[x]:valueCanonical 0..1 canonical() Code|uri|canonical
Required Pattern: https://profiles.ihe.net/RAD/MADO/StructureDefinition/MadoFhirBundle (extensions allowed)
DocumentReference.content.Slices for extension.extension:profile.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile"
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/fhir+json (extensions allowed)
DocumentReference.content.attachment.language This element has obligations and must be supported. This element is included in summaries. 1..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.attachment.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element has obligations and must be supported. This element is included in summaries. 1..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format This element has obligations and must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE_FormatCode_vs (1.5.0) (preferred)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.format.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.format.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode (no extensions allowed)
DocumentReference.content.format.version This element is included in summaries. 0..1 string Version of the system - if relevant
DocumentReference.content.format.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Fixed Value: urn:ihe:rad:MADO:fhir-manifest:2026 (no extensions allowed)
DocumentReference.content.format.display This element is included in summaries. 0..1 string Representation defined by the system
DocumentReference.content.format.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
DocumentReference.context This element has obligations and must be supported. This element is included in summaries. 1..1 BackboneElement Clinical context of document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented, could include the study procedure codes.
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element has obligations and must be supported. This element is included in summaries. 1..1 Period Time of service that is being documented
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.period.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.period.start This element is included in summaries. C 1..1 dateTime The start time of the study referred to by the manifest
DocumentReference.context.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
DocumentReference.context.facilityType This element has obligations and must be supported. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.practiceSetting This element has obligations and must be supported. 1..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo This element has obligations and must be supported. 0..1 Reference(Patient) Patient demographics from source
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.sourcePatientInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.sourcePatientInfo.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
DocumentReference.context.sourcePatientInfo.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
DocumentReference.context.sourcePatientInfo.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
DocumentReference.context.sourcePatientInfo.display This element is included in summaries. 0..1 string Text alternative for the resource
DocumentReference.context.Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by profile:identifier
DocumentReference.context.Slices for related.related:study-instance-uid This element must be supported. 1..1 MadoReferencedStudyInstanceUidIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID.
DocumentReference.context.Slices for related.related:accession-number This element must be supported. 0..1 MadoReferencedAccessionNumberIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number.

doco Documentation for this format
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / Slices for extension
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo
DocumentReference / context / Slices for related

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.extension:bodysite.​value[x] Base required ValueSet: Anatomical Region 📦1.0.0 Manifest-based Access to DICOM Objects v1.0
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo:kos-reference.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​extension:profile.extension:value.​value[x] Base preferred Cross-version ValueSet R5.HL7FormatCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📍1.5.0 IHE FormatCode Vocabulary v1.5
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mado-docref-1 error DocumentReference masterIdentifier, when used, need to be present as an identifier as well masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / Slices for extension
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo
DocumentReference / context / Slices for related

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference C 0..* MadoFhirDocumentReference A reference to a document
Constraints: mado-docref-1
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for extension.extension:bodysite This element has obligations and must be supported. 1..* (Complex) Extension: DocumentReference.bodySite
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for extension.extension:bodysite.extension 0..0 Extension
Slice: Unordered, Open by value:url
DocumentReference.Slices for extension.extension:bodysite.url 1..1 uri "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite"
DocumentReference.Slices for extension.extension:bodysite.value[x] 0..1 CodeableConcept The anatomical region of the patient that is the focus of the imaging manifest, concept field is required.
Binding: ValueSet: Anatomical Region (required)
DocumentReference.Slices for extension.extension:modality This element has obligations and must be supported. 1..* CodeableConcept Extension: DocumentReference.modality (R5 cross-version)
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The identifier of the FHIR Imaging Study Manifest.
DocumentReference.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:entryUUID This element has obligations and must be supported. This element is included in summaries. 0..* EntryUUIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Other identifiers for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
DocumentReference.type This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible), see section 6.X.6 of volume 3.
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "18748-4"
    }
  ]
}
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.category This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Categorization of document, see section 6.X.6 of volume 3.
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO Patient) Who/what is the subject of the document
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.date This element has obligations and must be supported. This element is included in summaries. 0..1 instant When this document reference was created
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author This element has obligations and must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document (i.e. manifest)
Slice: Unordered, Open by profile:$this.resolve()
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for author.author:source-organization This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator Organization) The organization that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author.author:source-device This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator) The device that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
DocumentReference.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:All Slices.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.Slices for relatesTo.relatesTo:All Slices.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.Slices for relatesTo.relatesTo:kos-reference This element has obligations and must be supported. This element is included in summaries. 0..1 BackboneElement Reference to the DocumentReference resource that contains the DICOM KOS manifest that corresponds to this imaging manifest in FHIR format
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Required Pattern: transforms (extensions allowed)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.target This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests) Target of the relationship
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.securityLabel This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ObligationsActor
MAY:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Clinical context of the manifest
DocumentReference.content.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
DocumentReference.content.Slices for extension.extension:profile 1..* (Complex) Contains the profile of the referred report
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value 1..1 Extension Extension
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.url 1..1 uri "value"
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] 1..1 Code|uri|canonical
Slice: Unordered, Open by type:$this
Binding: R5V3HL7FormatCodesForR4 (0.1.0) (preferred): Document Format Codes.
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCoding Coding
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueUri uri
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCanonical canonical(Any)
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].value[x]:valueCanonical 0..1 canonical() Code|uri|canonical
Required Pattern: https://profiles.ihe.net/RAD/MADO/StructureDefinition/MadoFhirBundle (extensions allowed)
DocumentReference.content.Slices for extension.extension:profile.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile"
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/fhir+json (extensions allowed)
DocumentReference.content.attachment.language This element has obligations and must be supported. This element is included in summaries. 1..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.attachment.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.creation This element has obligations and must be supported. This element is included in summaries. 1..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format This element has obligations and must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE_FormatCode_vs (1.5.0) (preferred)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode (no extensions allowed)
DocumentReference.content.format.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Fixed Value: urn:ihe:rad:MADO:fhir-manifest:2026 (no extensions allowed)
DocumentReference.context This element has obligations and must be supported. This element is included in summaries. 1..1 BackboneElement Clinical context of document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.period This element has obligations and must be supported. This element is included in summaries. 1..1 Period Time of service that is being documented
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.period.start This element is included in summaries. C 1..1 dateTime The start time of the study referred to by the manifest
DocumentReference.context.facilityType This element has obligations and must be supported. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.practiceSetting This element has obligations and must be supported. 1..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo This element has obligations and must be supported. 0..1 Reference(Patient) Patient demographics from source
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by profile:identifier
DocumentReference.context.Slices for related.related:study-instance-uid This element must be supported. 1..1 MadoReferencedStudyInstanceUidIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID.
DocumentReference.context.Slices for related.related:accession-number This element must be supported. 0..1 MadoReferencedAccessionNumberIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number.

doco Documentation for this format
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / Slices for extension
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo
DocumentReference / context / Slices for related

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.extension:bodysite.​value[x] Base required ValueSet: Anatomical Region 📦1.0.0 Manifest-based Access to DICOM Objects v1.0
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo:kos-reference.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​extension:profile.extension:value.​value[x] Base preferred Cross-version ValueSet R5.HL7FormatCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📍1.5.0 IHE FormatCode Vocabulary v1.5
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mado-docref-1 error DocumentReference masterIdentifier, when used, need to be present as an identifier as well masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()

Differential View

This structure is derived from MadoFhirDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference 0..* MadoFhirDocumentReference A reference to a document
DocumentReference.extension 2..* Extension Extension
DocumentReference.Slices for extension Content/Rules for all slices
DocumentReference.Slices for extension.extension:bodysite This element has obligations. 1..* MadoDocumentReferenceBodySite Extension: DocumentReference.bodySite
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for extension.extension:bodysite.value[x] 0..1 CodeableConcept The anatomical region of the patient that is the focus of the imaging manifest, concept field is required.
Binding: ValueSet: Anatomical Region (required)
DocumentReference.Slices for extension.extension:modality This element has obligations. 1..* MadoDocumentReferenceModality Extension: DocumentReference.modality (R5 cross-version)
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.identifier This element has obligations. 1..* Identifier Other identifiers for the document
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for identifier Content/Rules for all slices
DocumentReference.Slices for identifier.identifier:entryUUID This element has obligations. 0..* EntryUUIDIdentifier Other identifiers for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.type This element has obligations. 1..1 CodeableConcept Kind of document (LOINC if possible), see section 6.X.6 of volume 3.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "18748-4"
    }
  ]
}
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.category This element has obligations. 1..1 CodeableConcept Categorization of document, see section 6.X.6 of volume 3.
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.subject This element has obligations. 1..1 Reference(EU MADO Patient) Who/what is the subject of the document
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.date This element has obligations. 0..1 instant When this document reference was created
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.author This element has obligations. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document (i.e. manifest)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author Content/Rules for all slices
DocumentReference.Slices for author.author:source-organization This element has obligations. 0..1 Reference(EU MADO Creator Organization) The organization that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author.author:source-device This element has obligations. 0..1 Reference(EU MADO Creator) The device that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo Content/Rules for all slices
DocumentReference.Slices for relatesTo.relatesTo:kos-reference This element has obligations. 0..1 BackboneElement Reference to the DocumentReference resource that contains the DICOM KOS manifest that corresponds to this imaging manifest in FHIR format
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.target This element has obligations and must be supported. 1..1 Reference(EU MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests) Target of the relationship
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.securityLabel This element has obligations. 0..* CodeableConcept Document security-tags
ObligationsActor
MAY:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content
DocumentReference.content.attachment
DocumentReference.content.attachment.language This element has obligations. 1..1 code Human language of the content (BCP-47)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.attachment.creation This element has obligations. 1..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format This element has obligations. 1..1 Coding Format/content rules for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context This element has obligations and must be supported. 1..1 BackboneElement Clinical context of document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.period This element has obligations. 1..1 Period Time of service that is being documented
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.facilityType This element has obligations. 1..1 CodeableConcept Kind of facility where patient was seen
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.practiceSetting This element has obligations. 1..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo This element has obligations. 0..1 Reference(Patient) Patient demographics from source
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)

doco Documentation for this format
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / identifier
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / author
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.extension:bodysite.​value[x] Base required ValueSet: Anatomical Region 📦1.0.0 Manifest-based Access to DICOM Objects v1.0

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
DocumentReference C 0..* MadoFhirDocumentReference A reference to a document
Constraints: mado-docref-1
DocumentReference.id This element is included in summaries. 0..1 id Logical id of this artifact
DocumentReference.meta This element is included in summaries. 0..1 Meta Metadata about the resource
DocumentReference.meta.id 0..1 string Unique id for inter-element referencing
DocumentReference.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
DocumentReference.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
DocumentReference.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
DocumentReference.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
DocumentReference.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
DocumentReference.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
DocumentReference.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
DocumentReference.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained 0..* Resource Contained, inline Resources
DocumentReference.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for extension.extension:bodysite This element has obligations and must be supported. 1..* (Complex) Extension: DocumentReference.bodySite
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for extension.extension:bodysite.id 0..1 string Unique id for inter-element referencing
DocumentReference.Slices for extension.extension:bodysite.extension 0..0 Extension
Slice: Unordered, Open by value:url
DocumentReference.Slices for extension.extension:bodysite.url 1..1 uri "https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.bodySite"
DocumentReference.Slices for extension.extension:bodysite.value[x] 0..1 CodeableConcept The anatomical region of the patient that is the focus of the imaging manifest, concept field is required.
Binding: ValueSet: Anatomical Region (required)
DocumentReference.Slices for extension.extension:modality This element has obligations and must be supported. 1..* CodeableConcept Extension: DocumentReference.modality (R5 cross-version)
URL: https://profiles.ihe.net/RAD/MADO/StructureDefinition/ext-R5-DocumentReference.modality
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.masterIdentifier This element is included in summaries. 1..1 UniqueIdIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well The identifier of the FHIR Imaging Study Manifest.
DocumentReference.Slices for identifier This element has obligations and must be supported. This element is included in summaries. 1..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for identifier.identifier:entryUUID This element has obligations and must be supported. This element is included in summaries. 0..* EntryUUIDIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well Other identifiers for the document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.status This element is a modifier element. This element is included in summaries. 1..1 code current | superseded | entered-in-error
Binding: MHD DocumentReference status codes (required)
DocumentReference.type This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Kind of document (LOINC if possible), see section 6.X.6 of volume 3.
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
Required Pattern:
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "18748-4"
    }
  ]
}
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.category This element has obligations and must be supported. This element is included in summaries. 1..1 CodeableConcept Categorization of document, see section 6.X.6 of volume 3.
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.subject This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO Patient) Who/what is the subject of the document
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.date This element has obligations and must be supported. This element is included in summaries. 0..1 instant When this document reference was created
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author This element has obligations and must be supported. This element is included in summaries. 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document (i.e. manifest)
Slice: Unordered, Open by profile:$this.resolve()
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for author.author:source-organization This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator Organization) The organization that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for author.author:source-device This element has obligations and must be supported. This element is included in summaries. 0..1 Reference(EU MADO Creator) The device that generated the manifest.
ObligationsActor
SHALL:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated the document (i.e. manifest)
DocumentReference.custodian 0..1 Reference(Organization) Organization which maintains the document (i.e. manifest)
DocumentReference.Slices for relatesTo This element must be supported. This element is included in summaries. 0..* BackboneElement Relationships to other documents
Slice: Unordered, Open by value:code

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
DocumentReference.Slices for relatesTo.relatesTo:All Slices Content/Rules for all slices
DocumentReference.Slices for relatesTo.relatesTo:All Slices.id 0..1 string Unique id for inter-element referencing
DocumentReference.Slices for relatesTo.relatesTo:All Slices.extension 0..* Extension Additional content defined by implementations
DocumentReference.Slices for relatesTo.relatesTo:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:All Slices.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.Slices for relatesTo.relatesTo:All Slices.target This element is included in summaries. 1..1 Reference(DocumentReference) Target of the relationship
DocumentReference.Slices for relatesTo.relatesTo:kos-reference This element has obligations and must be supported. This element is included in summaries. 0..1 BackboneElement Reference to the DocumentReference resource that contains the DICOM KOS manifest that corresponds to this imaging manifest in FHIR format
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.id 0..1 string Unique id for inter-element referencing
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.extension 0..* Extension Additional content defined by implementations
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.code This element is included in summaries. 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
Required Pattern: transforms (extensions allowed)
DocumentReference.Slices for relatesTo.relatesTo:kos-reference.target This element has obligations and must be supported. This element is included in summaries. 1..1 Reference(EU MADO MHD DocumentReference Profile for DICOM KOS Imaging Manifests) Target of the relationship
ObligationsActor
SHALL:populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.description This element is included in summaries. 0..1 string Human-readable description
DocumentReference.securityLabel This element has obligations and must be supported. This element is included in summaries. 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ObligationsActor
MAY:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content This element is included in summaries. 1..1 BackboneElement Clinical context of the manifest
DocumentReference.content.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
DocumentReference.content.Slices for extension.extension:profile 1..* (Complex) Contains the profile of the referred report
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.Slices for extension.extension:profile.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value 1..1 Extension Extension
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.url 1..1 uri "value"
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] 1..1 Code|uri|canonical
Slice: Unordered, Open by type:$this
Binding: R5V3HL7FormatCodesForR4 (0.1.0) (preferred): Document Format Codes.
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCoding Coding
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueUri uri
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].valueCanonical canonical(Any)
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x] Content/Rules for all slices
DocumentReference.content.Slices for extension.extension:profile.Slices for extension.extension:value.Slices for value[x].value[x]:valueCanonical 0..1 canonical() Code|uri|canonical
Required Pattern: https://profiles.ihe.net/RAD/MADO/StructureDefinition/MadoFhirBundle (extensions allowed)
DocumentReference.content.Slices for extension.extension:profile.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.content.profile"
DocumentReference.content.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.content.attachment This element is included in summaries. 1..1 Attachment Where to access the document
DocumentReference.content.attachment.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.attachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType This element is included in summaries. 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Required Pattern: application/fhir+json (extensions allowed)
DocumentReference.content.attachment.language This element has obligations and must be supported. This element is included in summaries. 1..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.attachment.url This element is included in summaries. 1..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size This element is included in summaries. 0..1 unsignedInt Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
DocumentReference.content.attachment.creation This element has obligations and must be supported. This element is included in summaries. 1..1 dateTime Date attachment was first created
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format This element has obligations and must be supported. This element is included in summaries. 1..1 Coding Format/content rules for the document
Binding: IHE_FormatCode_vs (1.5.0) (preferred)
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.content.format.id 0..1 string Unique id for inter-element referencing
DocumentReference.content.format.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.content.format.system This element is included in summaries. 0..1 uri Identity of the terminology system
Fixed Value: http://ihe.net/fhir/ihe.formatcode.fhir/CodeSystem/formatcode (no extensions allowed)
DocumentReference.content.format.version This element is included in summaries. 0..1 string Version of the system - if relevant
DocumentReference.content.format.code This element is included in summaries. 0..1 code Symbol in syntax defined by the system
Fixed Value: urn:ihe:rad:MADO:fhir-manifest:2026 (no extensions allowed)
DocumentReference.content.format.display This element is included in summaries. 0..1 string Representation defined by the system
DocumentReference.content.format.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
DocumentReference.context This element has obligations and must be supported. This element is included in summaries. 1..1 BackboneElement Clinical context of document
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.extension 0..* Extension Additional content defined by implementations
DocumentReference.context.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
DocumentReference.context.encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
DocumentReference.context.event 0..* CodeableConcept Main clinical acts documented, could include the study procedure codes.
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period This element has obligations and must be supported. This element is included in summaries. 1..1 Period Time of service that is being documented
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.period.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.period.start This element is included in summaries. C 1..1 dateTime The start time of the study referred to by the manifest
DocumentReference.context.period.end This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
DocumentReference.context.facilityType This element has obligations and must be supported. 1..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.practiceSetting This element has obligations and must be supported. 1..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo This element has obligations and must be supported. 0..1 Reference(Patient) Patient demographics from source
ObligationsActor
SHOULD:able-to-populate Content Creator/Document Source (Imaging Manifest)
DocumentReference.context.sourcePatientInfo.id 0..1 string Unique id for inter-element referencing
DocumentReference.context.sourcePatientInfo.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
DocumentReference.context.sourcePatientInfo.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
DocumentReference.context.sourcePatientInfo.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
DocumentReference.context.sourcePatientInfo.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
DocumentReference.context.sourcePatientInfo.display This element is included in summaries. 0..1 string Text alternative for the resource
DocumentReference.context.Slices for related 1..* Reference(Resource) Related identifiers or resources
Slice: Unordered, Open by profile:identifier
DocumentReference.context.Slices for related.related:study-instance-uid This element must be supported. 1..1 MadoReferencedStudyInstanceUidIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Study Instance UID of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Study Instance UID.
DocumentReference.context.Slices for related.related:accession-number This element must be supported. 0..1 MadoReferencedAccessionNumberIdentifier The snapshot does not say whether the constraints on the root of this type profile have been applied to this element, so assume they have not. Check the type profile directly as well(Resource) The Accession Number of the imaging study that is the focus of the imaging manifest, represented as an Identifier with a fixed system and a value that corresponds to the Accession Number.

doco Documentation for this format
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / Slices for extension
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo
DocumentReference / context / Slices for related

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.meta.​security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.meta.​tag Base example Common Tags 📍4.0.1 FHIR Std.
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.extension:bodysite.​value[x] Base required ValueSet: Anatomical Region 📦1.0.0 Manifest-based Access to DICOM Objects v1.0
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.3 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📍4.0.1 FHIR Std.
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.relatesTo:kos-reference.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​extension:profile.extension:value.​value[x] Base preferred Cross-version ValueSet R5.HL7FormatCodes for use in FHIR R4 📍0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📍1.5.0 IHE FormatCode Vocabulary v1.5
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.4
DocumentReference.context.​facilityType Base example Facility Type Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​practiceSetting Base example Practice Setting Code Value Set 📍4.0.1 FHIR Std.
DocumentReference.context.​sourcePatientInfo.type Base extensible ResourceType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error DocumentReference If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error DocumentReference If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
mado-docref-1 error DocumentReference masterIdentifier, when used, need to be present as an identifier as well masterIdentifier.exists() implies identifier.where( %resource.masterIdentifier.system = system and %resource.masterIdentifier.value = value ).exists()
NameContent Creator/Document Source (Imaging Manifest)doco
DocumentReference
DocumentReference / Slices for extension
DocumentReference / Slices for extension / extension:bodysite
DocumentReference / Slices for extension / extension:modality
DocumentReference / Slices for identifier
DocumentReference / Slices for identifier / identifier:entryUUID
DocumentReference / type
DocumentReference / category
DocumentReference / subject
DocumentReference / date
DocumentReference / Slices for author
DocumentReference / Slices for author / author:source-organization
DocumentReference / Slices for author / author:source-device
DocumentReference / Slices for relatesTo
DocumentReference / Slices for relatesTo / relatesTo:kos-reference
DocumentReference / Slices for relatesTo / relatesTo:kos-reference / target
DocumentReference / securityLabel
DocumentReference / content
DocumentReference / content / Slices for extension
DocumentReference / content / attachment
DocumentReference / content / attachment / language
DocumentReference / content / attachment / creation
DocumentReference / content / format
DocumentReference / context
DocumentReference / context / period
DocumentReference / context / facilityType
DocumentReference / context / practiceSetting
DocumentReference / context / sourcePatientInfo
DocumentReference / context / Slices for related

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron