HL7 Europe IG Snapshot
0.0.2 - ci-build Unknown country code 'EU'

HL7 Europe IG Snapshot, published by Lithuanian Medical Library. This guide is not an authorized publication; it is the continuous build for version 0.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7LT/ig-eu-ehds/ and changes regularly. See the Directory of published versions

Resursų profilis: EU DocumentReference

Oficialus URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/DocumentReferenceEu Versija: 0.1.0-ballot
Standards status: Draft Draft nuo 2025-05-14 Brandos lygis: 1 Mašiniškai apdorojamas pavadinimas: DocumentReferenceEu

Autorių teisės/Teisinė informacija: Used by permission of HL7 Europe, all rights reserved Creative Commons License

A DocumentReference profile for the EU.

Usages:

You can also check for usages in the FHIR IG Statistics

Profilio turinio formaliosios peržiūros

Profilių, skirtumų rinkinių, momentinių kopijų aprašas ir jų reprezentacijos.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference(5.0.0) A reference to a document
Constraints: docRef-1, docRef-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:note 0..1 Annotation Additional notes that apply to this resource or element.
URL: http://hl7.org/fhir/StructureDefinition/note
Constraints: ext-1
.... extension:view 0..1 CodeableConcept Media.view extension
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CrossVersionMediaViewExtension
Binding: http://hl7.eu/fhir/imaging-r5/ValueSet/media-view (required)
Constraints: ext-1
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... content Σ 1..* BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
ele-1 error DocumentReference.implicitRules, DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.status, DocumentReference.context, DocumentReference.content, DocumentReference.content.modifierExtension, DocumentReference.content.attachment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.content.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(5.0.0) A reference to a document
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:note 0..1 Annotation Additional notes that apply to this resource or element.
URL: http://hl7.org/fhir/StructureDefinition/note
.... extension:view 0..1 CodeableConcept Media.view extension
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CrossVersionMediaViewExtension
Binding: http://hl7.eu/fhir/imaging-r5/ValueSet/media-view (required)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference(5.0.0) A reference to a document
Constraints: docRef-1, docRef-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:note 0..1 Annotation Additional notes that apply to this resource or element.
URL: http://hl7.org/fhir/StructureDefinition/note
Constraints: ext-1
.... extension:view 0..1 CodeableConcept Media.view extension
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CrossVersionMediaViewExtension
Binding: http://hl7.eu/fhir/imaging-r5/ValueSet/media-view (required)
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifiers for the document
... version Σ 0..1 string An explicitly assigned identifer of a variation of the content in the DocumentReference
... basedOn 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) Procedure that caused this media to be created
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... modality Σ 0..* CodeableConcept Imaging modality used
Binding: Modality . (extensible): Type of acquired data in the instance.
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level.
... subject Σ 0..1 Reference(Resource) Who/what is the subject of the document
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... event 0..* CodeableReference() Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
... bodySite Σ 0..* CodeableReference(BodyStructure) Body part included
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
... practiceSetting C 0..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).
... period Σ 0..1 Period Time of service that is being documented
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester 0..* BackboneElement Attests to accuracy of the document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
.... time 0..1 dateTime When the document was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 markdown Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document
.... profile Σ 0..* BackboneElement Content profile rules for the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... value[x] Σ 1..1 Code|uri|canonical
Binding: HL7FormatCodes (2.1.0) (preferred): Document Format Codes.
...... valueCoding Coding
...... valueUri uri
...... valueCanonical canonical(Any)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 FHIR Std.
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base example Referenced Item Category Value Set 📍5.0.0 FHIR Std.
DocumentReference.event Base example v3 Code System ActCode 📍3.0.0 THO v7.1
DocumentReference.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
DocumentReference.facilityType Base example Facility Type Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.practiceSetting Base example Practice Setting Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​profile.value[x] Base preferred HL7 ValueSet of Format Codes for use with Document Sharing 📍2.1.0 THO v7.1

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
ele-1 error DocumentReference.meta, DocumentReference.implicitRules, DocumentReference.language, DocumentReference.text, DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.identifier, DocumentReference.version, DocumentReference.basedOn, DocumentReference.status, DocumentReference.docStatus, DocumentReference.modality, DocumentReference.type, DocumentReference.category, DocumentReference.subject, DocumentReference.context, DocumentReference.event, DocumentReference.bodySite, DocumentReference.facilityType, DocumentReference.practiceSetting, DocumentReference.period, DocumentReference.date, DocumentReference.author, DocumentReference.attester, DocumentReference.attester.extension, DocumentReference.attester.modifierExtension, DocumentReference.attester.mode, DocumentReference.attester.time, DocumentReference.attester.party, DocumentReference.custodian, DocumentReference.relatesTo, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code, DocumentReference.relatesTo.target, DocumentReference.description, DocumentReference.securityLabel, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.profile, DocumentReference.content.profile.extension, DocumentReference.content.profile.modifierExtension, DocumentReference.content.profile.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.attester.extension, DocumentReference.attester.modifierExtension, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.profile.extension, DocumentReference.content.profile.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Pagrindinių elementų peržiūra

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference(5.0.0) A reference to a document
Constraints: docRef-1, docRef-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:note 0..1 Annotation Additional notes that apply to this resource or element.
URL: http://hl7.org/fhir/StructureDefinition/note
Constraints: ext-1
.... extension:view 0..1 CodeableConcept Media.view extension
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CrossVersionMediaViewExtension
Binding: http://hl7.eu/fhir/imaging-r5/ValueSet/media-view (required)
Constraints: ext-1
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... content Σ 1..* BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
ele-1 error DocumentReference.implicitRules, DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.status, DocumentReference.context, DocumentReference.content, DocumentReference.content.modifierExtension, DocumentReference.content.attachment All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.content.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Skirtumų rinkinių peržiūra

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference(5.0.0) A reference to a document
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:note 0..1 Annotation Additional notes that apply to this resource or element.
URL: http://hl7.org/fhir/StructureDefinition/note
.... extension:view 0..1 CodeableConcept Media.view extension
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CrossVersionMediaViewExtension
Binding: http://hl7.eu/fhir/imaging-r5/ValueSet/media-view (required)

doco Documentation for this format

Momentinės kopijos peržiūraView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference(5.0.0) A reference to a document
Constraints: docRef-1, docRef-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:note 0..1 Annotation Additional notes that apply to this resource or element.
URL: http://hl7.org/fhir/StructureDefinition/note
Constraints: ext-1
.... extension:view 0..1 CodeableConcept Media.view extension
URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/CrossVersionMediaViewExtension
Binding: http://hl7.eu/fhir/imaging-r5/ValueSet/media-view (required)
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifiers for the document
... version Σ 0..1 string An explicitly assigned identifer of a variation of the content in the DocumentReference
... basedOn 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) Procedure that caused this media to be created
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus Σ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... modality Σ 0..* CodeableConcept Imaging modality used
Binding: Modality . (extensible): Type of acquired data in the instance.
... type Σ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category Σ 0..* CodeableConcept Categorization of document
Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level.
... subject Σ 0..1 Reference(Resource) Who/what is the subject of the document
... context C 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... event 0..* CodeableReference() Main clinical acts documented
Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented.
... bodySite Σ 0..* CodeableReference(BodyStructure) Body part included
Binding: SNOMEDCTBodyStructures (example): SNOMED CT Body site concepts
... facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
... practiceSetting C 0..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).
... period Σ 0..1 Period Time of service that is being documented
... date Σ 0..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester 0..* BackboneElement Attests to accuracy of the document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
.... time 0..1 dateTime When the document was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo Σ 0..* BackboneElement Relationships to other documents
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 0..1 markdown Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content Σ 1..* BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... attachment Σ 1..1 Attachment Where to access the document
.... profile Σ 0..* BackboneElement Content profile rules for the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... value[x] Σ 1..1 Code|uri|canonical
Binding: HL7FormatCodes (2.1.0) (preferred): Document Format Codes.
...... valueCoding Coding
...... valueUri uri
...... valueCanonical canonical(Any)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 FHIR Std.
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.modality Base extensible Modality . ⏿2025.3.20250714 tx.fhir.org
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base example Referenced Item Category Value Set 📍5.0.0 FHIR Std.
DocumentReference.event Base example v3 Code System ActCode 📍3.0.0 THO v7.1
DocumentReference.bodySite Base example SNOMED CT Body Structures 📍5.0.0 FHIR Std.
DocumentReference.facilityType Base example Facility Type Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.practiceSetting Base example Practice Setting Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​profile.value[x] Base preferred HL7 ValueSet of Format Codes for use with Document Sharing 📍2.1.0 THO v7.1

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error DocumentReference If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice DocumentReference A resource should have narrative for robust management text.`div`.exists()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
ele-1 error DocumentReference.meta, DocumentReference.implicitRules, DocumentReference.language, DocumentReference.text, DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.identifier, DocumentReference.version, DocumentReference.basedOn, DocumentReference.status, DocumentReference.docStatus, DocumentReference.modality, DocumentReference.type, DocumentReference.category, DocumentReference.subject, DocumentReference.context, DocumentReference.event, DocumentReference.bodySite, DocumentReference.facilityType, DocumentReference.practiceSetting, DocumentReference.period, DocumentReference.date, DocumentReference.author, DocumentReference.attester, DocumentReference.attester.extension, DocumentReference.attester.modifierExtension, DocumentReference.attester.mode, DocumentReference.attester.time, DocumentReference.attester.party, DocumentReference.custodian, DocumentReference.relatesTo, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.relatesTo.code, DocumentReference.relatesTo.target, DocumentReference.description, DocumentReference.securityLabel, DocumentReference.content, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.attachment, DocumentReference.content.profile, DocumentReference.content.profile.extension, DocumentReference.content.profile.modifierExtension, DocumentReference.content.profile.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error DocumentReference.extension, DocumentReference.extension:note, DocumentReference.extension:view, DocumentReference.modifierExtension, DocumentReference.attester.extension, DocumentReference.attester.modifierExtension, DocumentReference.relatesTo.extension, DocumentReference.relatesTo.modifierExtension, DocumentReference.content.extension, DocumentReference.content.modifierExtension, DocumentReference.content.profile.extension, DocumentReference.content.profile.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Kitos profilio reprezentacijos: CSV, Excel, Schematron