MyHealth@Eu NCPeH API
0.0.1 - ci-build 150

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

Resource Profile: DocumentReference: Minimal

Official URL: http://myhealth.eu/fhir/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu Version: 0.0.1
Draft as of 2025-05-20 Computable Name: DocumentReferenceMyHealthEu

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

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:modality-r5 0..* CodeableConcept Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.modality
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier Other document identifiers
ele-1: All FHIR elements must have a @value or children
... status ?!Σ 1..1 code Status of this document reference.
Binding: DocumentReferenceStatus (required): The status of the document reference.


ele-1: All FHIR elements must have a @value or children
Required Pattern: current
... docStatus Σ 0..1 code Composition status
Binding: CompositionStatus (required): Status of the underlying document.


ele-1: All FHIR elements must have a @value or children
... type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Binding: eHDSI Document Types (required)
ele-1: All FHIR elements must have a @value or children
... Slices for category Σ 0..* CodeableConcept Report Category
Slice: Unordered, Open by pattern:$this
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


ele-1: All FHIR elements must have a @value or children
.... category:studyType Σ 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)
ele-1: All FHIR elements must have a @value or children
... subject Σ 1..1 Reference(Patient: Minimal) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
... date Σ 1..1 instant When this document reference was created
ele-1: All FHIR elements must have a @value or children
... description Σ 1..1 string Human-readable description
ele-1: All FHIR elements must have a @value or children
... content ΣC 1..* BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
docref-no-data: attachment.data shall not be present if the document is not a PDF
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
..... 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.


ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
..... data 0..1 base64Binary Used only for PDF
ele-1: All FHIR elements must have a @value or children
..... url Σ 0..1 url Where the doc can be get
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredPattern: current
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|4.0.1
from the FHIR Standard
DocumentReference.typerequiredEHDSIDocumentTypes
http://myhealth.eu/fhir/ncp-api/ValueSet/eHDSIDocumentTypes
from this IG
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.category:studyTyperequiredEHDSILabStudyType
http://terminology.ehdsi.eu/ValueSet/eHDSILabStudyType
DocumentReference.content.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
docref-no-dataerrorDocumentReference.contentattachment.data shall not be present if the document is not a PDF
: attachment.where(contentType != 'application/pdf').data.empty()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron