MyHealth@Eu NCPeH API
9.1.0 - ci-build 150

MyHealth@Eu NCPeH API - Local Development build (v9.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: DocumentReference: Minimal

Official URL: http://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu Version: 9.1.0
Draft as of 2026-02-19 Computable Name: DocumentReferenceMyHealthEu

This profile defines the data set returned by the Myhealth@EU Document search service

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:modality-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Modality (required)
.... extension:bodySite 0..* (Complex) DocumentReference BodySite
URL: http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Anatomical Region (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Other document identifiers
... status ?!Σ 1..1 code Status of this document reference.
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
... docStatus Σ 0..1 code Composition status
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by value:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... category:labStudyType Σ 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: eHDSI Laboratory Study Types (required)
... subject Σ 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
... date Σ 1..1 instant When this document reference was created
... description Σ 1..1 string Human-readable description
... content ΣC 1..* BackboneElement Document referenced
Constraints: docref-no-data
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 0..1 code Type of data (e.g. PDF)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... data 0..1 base64Binary Used only for PDF
..... url Σ 0..1 url Where the doc can be get
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.extension:modality-r5.​value[x] Base required eHDSI Modality 📦9.1.0 This IG
DocumentReference.extension:bodySite.​value[x] Base required eHDSI Anatomical Region 📦9.1.0 This IG
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base required eHDSI Document Types 📦9.1.0 This IG
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.category:labStudyType Base required eHDSI Laboratory Study Types 📦9.1.0 This IG
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
docref-no-data error DocumentReference.content attachment.data shall not be present if the document is not a PDF attachment.where(contentType != 'application/pdf').data.empty()
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()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:modality-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
..... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Modality (required)
.... extension:bodySite 0..* (Complex) DocumentReference BodySite
URL: http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite
..... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Anatomical Region (required)
... masterIdentifier 1..1 Identifier Master Version Specific Identifier
... identifier 0..* Identifier Other document identifiers
... docStatus 0..1 code Composition status
... type 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
... Slices for category 0..* CodeableConcept Report Category
Slice: Unordered, Open by value:$this
.... category:labStudyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: eHDSI Laboratory Study Types (required)
... subject 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
... date 1..1 instant When this document reference was created
... description 1..1 string Human-readable description
... content C 1..* BackboneElement Document referenced
Constraints: docref-no-data
.... attachment
..... contentType 0..1 code Type of data (e.g. PDF)
..... data 0..1 base64Binary Used only for PDF
..... url 0..1 url Where the doc can be get
... context
.... period 0..1 Period Time the service documented

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.extension:modality-r5.​value[x] Base required eHDSI Modality 📦9.1.0 This IG
DocumentReference.extension:bodySite.​value[x] Base required eHDSI Anatomical Region 📦9.1.0 This IG
DocumentReference.type Base required eHDSI Document Types 📦9.1.0 This IG
DocumentReference.category:labStudyType Base required eHDSI Laboratory Study Types 📦9.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
docref-no-data error DocumentReference.content attachment.data shall not be present if the document is not a PDF attachment.where(contentType != 'application/pdf').data.empty()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... 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
... 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
.... extension:modality-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Modality (required)
.... extension:bodySite 0..* (Complex) DocumentReference BodySite
URL: http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Anatomical Region (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 1..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other document identifiers
... status ?!Σ 1..1 code Status of this document reference.
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
... docStatus Σ 0..1 code Composition status
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by value:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... category:labStudyType Σ 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: eHDSI Laboratory Study Types (required)
... subject Σ 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
... date Σ 1..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 1..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content ΣC 1..* BackboneElement Document referenced
Constraints: docref-no-data
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 0..1 code Type of data (e.g. PDF)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Used only for PDF
..... url Σ 0..1 url Where the doc can be get
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time the service documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 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).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.extension:modality-r5.​value[x] Base required eHDSI Modality 📦9.1.0 This IG
DocumentReference.extension:bodySite.​value[x] Base required eHDSI Anatomical Region 📦9.1.0 This IG
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base required eHDSI Document Types 📦9.1.0 This IG
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.category:labStudyType Base required eHDSI Laboratory Study Types 📦9.1.0 This IG
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
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
docref-no-data error DocumentReference.content attachment.data shall not be present if the document is not a PDF attachment.where(contentType != 'application/pdf').data.empty()
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()

This structure is derived from DocumentReference

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.category

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:modality-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Modality (required)
.... extension:bodySite 0..* (Complex) DocumentReference BodySite
URL: http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Anatomical Region (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Other document identifiers
... status ?!Σ 1..1 code Status of this document reference.
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
... docStatus Σ 0..1 code Composition status
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by value:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... category:labStudyType Σ 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: eHDSI Laboratory Study Types (required)
... subject Σ 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
... date Σ 1..1 instant When this document reference was created
... description Σ 1..1 string Human-readable description
... content ΣC 1..* BackboneElement Document referenced
Constraints: docref-no-data
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType Σ 0..1 code Type of data (e.g. PDF)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... data 0..1 base64Binary Used only for PDF
..... url Σ 0..1 url Where the doc can be get
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.extension:modality-r5.​value[x] Base required eHDSI Modality 📦9.1.0 This IG
DocumentReference.extension:bodySite.​value[x] Base required eHDSI Anatomical Region 📦9.1.0 This IG
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base required eHDSI Document Types 📦9.1.0 This IG
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.category:labStudyType Base required eHDSI Laboratory Study Types 📦9.1.0 This IG
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
docref-no-data error DocumentReference.content attachment.data shall not be present if the document is not a PDF attachment.where(contentType != 'application/pdf').data.empty()
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()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:modality-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
..... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Modality (required)
.... extension:bodySite 0..* (Complex) DocumentReference BodySite
URL: http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite
..... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Anatomical Region (required)
... masterIdentifier 1..1 Identifier Master Version Specific Identifier
... identifier 0..* Identifier Other document identifiers
... docStatus 0..1 code Composition status
... type 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
... Slices for category 0..* CodeableConcept Report Category
Slice: Unordered, Open by value:$this
.... category:labStudyType 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: eHDSI Laboratory Study Types (required)
... subject 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
... date 1..1 instant When this document reference was created
... description 1..1 string Human-readable description
... content C 1..* BackboneElement Document referenced
Constraints: docref-no-data
.... attachment
..... contentType 0..1 code Type of data (e.g. PDF)
..... data 0..1 base64Binary Used only for PDF
..... url 0..1 url Where the doc can be get
... context
.... period 0..1 Period Time the service documented

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.extension:modality-r5.​value[x] Base required eHDSI Modality 📦9.1.0 This IG
DocumentReference.extension:bodySite.​value[x] Base required eHDSI Anatomical Region 📦9.1.0 This IG
DocumentReference.type Base required eHDSI Document Types 📦9.1.0 This IG
DocumentReference.category:labStudyType Base required eHDSI Laboratory Study Types 📦9.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
docref-no-data error DocumentReference.content attachment.data shall not be present if the document is not a PDF attachment.where(contentType != 'application/pdf').data.empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... 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
... 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
.... extension:modality-r5 0..* (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: eHDSI Modality (required)
.... extension:bodySite 0..* (Complex) DocumentReference BodySite
URL: http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://myhealth.eu/fhir/StructureDefinition/DocumentReference-bodysite"
..... value[x] 0..1 CodeableConcept Value of extension
Binding: eHDSI Anatomical Region (required)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier Σ 1..1 Identifier Master Version Specific Identifier
... identifier Σ 0..* Identifier Other document identifiers
... status ?!Σ 1..1 code Status of this document reference.
Binding: DocumentReferenceStatus (required): The status of the document reference.
Required Pattern: current
... docStatus Σ 0..1 code Composition status
Binding: CompositionStatus (required): Status of the underlying document.
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by value:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
.... category:labStudyType Σ 0..* CodeableConcept The way of grouping of the test results into clinically meaningful domains (e.g. hematology study, microbiology study, etc.)
Binding: eHDSI Laboratory Study Types (required)
... subject Σ 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
... date Σ 1..1 instant When this document reference was created
... author Σ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
... authenticator 0..1 Reference(Practitioner | PractitionerRole | Organization) Who/what authenticated 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description Σ 1..1 string Human-readable description
... securityLabel Σ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
... content ΣC 1..* BackboneElement Document referenced
Constraints: docref-no-data
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType Σ 0..1 code Type of data (e.g. PDF)
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
..... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
..... data 0..1 base64Binary Used only for PDF
..... url Σ 0..1 url Where the doc can be get
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
..... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation Σ 0..1 dateTime Date attachment was first created
.... format Σ 0..1 Coding Format/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
... context Σ 0..1 BackboneElement Clinical context of document
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... encounter 0..* Reference(Encounter | EpisodeOfCare) Context of the document content
.... event 0..* CodeableConcept Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
.... period Σ 0..1 Period Time the service documented
.... facilityType 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
.... practiceSetting 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).
.... sourcePatientInfo 0..1 Reference(Patient) Patient demographics from source
.... related 0..* Reference(Resource) Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.extension:modality-r5.​value[x] Base required eHDSI Modality 📦9.1.0 This IG
DocumentReference.extension:bodySite.​value[x] Base required eHDSI Anatomical Region 📦9.1.0 This IG
DocumentReference.status Base required DocumentReferenceStatus 📍4.0.1 FHIR Std.
DocumentReference.docStatus Base required CompositionStatus 📍4.0.1 FHIR Std.
DocumentReference.type Base required eHDSI Document Types 📦9.1.0 This IG
DocumentReference.category Base example Document Class Value Set 📍4.0.1 FHIR Std.
DocumentReference.category:labStudyType Base required eHDSI Laboratory Study Types 📦9.1.0 This IG
DocumentReference.relatesTo.​code Base required DocumentRelationshipType 📍4.0.1 FHIR Std.
DocumentReference.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.contentType Base required MimeType 📍4.0.1 FHIR Std.
DocumentReference.content.​attachment.language Base preferred Common Languages 📍4.0.1 FHIR Std.
DocumentReference.content.​format Base preferred DocumentReference Format Code Set 📍4.0.1 FHIR Std.
DocumentReference.context.​event Base example v3 Code System ActCode 📦3.0.0 THO v7.0
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
docref-no-data error DocumentReference.content attachment.data shall not be present if the document is not a PDF attachment.where(contentType != 'application/pdf').data.empty()
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()

This structure is derived from DocumentReference

Summary

Mandatory: 5 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of DocumentReference.category

 

Other representations of profile: CSV, Excel, Schematron