DK MedCom Document
1.0.1 - release

DK MedCom Document, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-medcom-document/ and changes regularly. See the Directory of published versions

Resource Profile: MedComContainedDocumentReference

Official URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-contained-documentreference Version: 1.0.1
Active as of 2025-11-17 Computable Name: MedComContainedDocumentReference

A profile stating the rules, when exchanging a FHIR document in the Danish Healthcare sector using IHE MHD and IHE XDS based document sharing.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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..* MedComMinimalDocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionid 1..1 string Specifies the version of the DocumentReference profile for a standard.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:homeCommunityid S 1..1 Coding [DocumentEntry.homeCommunityId] A unique identifier for a community where the DocumentEntry and document can be accessed
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-homecommunityid-extension
... masterIdentifier S 1..1 UniqueIdIdentifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:entryUUID 0..1 EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: MHD DocumentReference status codes (required)
... type SΣ 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
... category SΣ 1..1 CodeableConcept [DocumentEntry.class] Categorization of document
Binding: IHE ClassCode (extensible)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
... subject SΣ 1..1 Reference(MedComDocumentPatient) {c} [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... Slices for author SΣ 1..2 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) {c} [DocumentEntry.author] Who and/or what authored the document
Slice: Unordered, Closed by type:$this.resolve()
.... author:institution SΣ 1..1 Reference(MedComDocumentOrganization) {c} [DocumentEntry.author.authorInstitution] The organization who authored the document
.... author:person SΣ 0..1 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... 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
... securityLabel SΣ 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
... content SΣ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType SΣ 1..1 code [DocumentEntry.mimeType] Mime type of the content, with charset etc.
Binding: IHE MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
Example General: en-AU
..... url Σ 1..1 url [DocumentEntry.URI] Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt [DocumentEntry.size] Number of bytes of content
..... hash SΣ 0..1 base64Binary [DocumentEntry.hash] Hash of the data (sha-1)
..... title SΣ 1..1 string [DocumentEntry.title] The readable title of the document
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime [DocumentEntry.creationTime] Date attachment was first created
.... format SΣ 1..1 Coding [DocumentEntry.formatCode] Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..* CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: ActCode (3.0.0) (required)
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... period SΣ 0..1 Period [DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime] Time of service that is being documented
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 1..1 CodeableConcept [DocumentEntry.healthcareFacilityTypeCode] Kind of facility where patient was seen
Binding: DK SOR Organization Type (extensible)
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE HealthcareFacilityTypeCode (extensible)
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... practiceSetting S 1..1 CodeableConcept [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty)
Binding: Replication og DK SOR Practice Setting Code (extensible)
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE PracticeSettingCode (extensible)
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... sourcePatientInfo S 1..1 Reference(MedComDocumentPatient) [DocumentEntry.sourcePatientId and DocumentEntry.sourcePatientInfo] Patient demographics from source. Must be the same reference as in DocumentReference.subject.
.... related S 0..* Reference(Resource) [DocumentEntry.referenceIdList] Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.masterIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.2 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base extensible IHE ClassCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
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 IHE MimeType 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.language Base extensible IHE LanguageCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📦1.2.0 IHE FormatCode Vocabulary v1.2
DocumentReference.context.​event Base required v3 Code System ActCode 📍3.0.0 THO v7.0
DocumentReference.context.​facilityType Base extensible DK SOR Organization Type 📦3.4.0 HL7 FHIR Implementation Guide: DK Core v3.4
DocumentReference.context.​facilityType.coding.​system Base extensible IHE HealthcareFacilityTypeCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​practiceSetting Base extensible Replication og DK SOR Practice Setting Code 📦1.0.1 This IG
DocumentReference.context.​practiceSetting.coding.​system Base extensible IHE PracticeSettingCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0

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()
uuid error DocumentReference.identifier General UUID expression value.matches('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')

This structure is derived from MedComMinimalDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MedComMinimalDocumentReference A reference to a document
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:homeCommunityid S 1..1 Coding [DocumentEntry.homeCommunityId] A unique identifier for a community where the DocumentEntry and document can be accessed
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-homecommunityid-extension
... masterIdentifier S 1..1 UniqueIdIdentifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... value S 1..1 string The value that is unique
.... value S 1..1 string The value that is unique
... Slices for identifier Content/Rules for all slices
.... identifier:entryUUID 0..1 EntryUUIDIdentifier An identifier intended for computation
... status S 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
... type 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
... category 1..1 CodeableConcept [DocumentEntry.class] Categorization of document
Binding: IHE ClassCode (extensible)
.... coding
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
... subject 1..1 Reference(MedComDocumentPatient) {c} [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document
... Slices for author 1..2 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) {c} [DocumentEntry.author] Who and/or what authored the document
Slice: Unordered, Closed by type:$this.resolve()
.... author:institution S 1..1 Reference(MedComDocumentOrganization) {c} [DocumentEntry.author.authorInstitution] The organization who authored the document
.... author:person S 0..1 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... securityLabel 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
... content S 1..1 BackboneElement Document referenced
.... attachment
..... contentType S 1..1 code [DocumentEntry.mimeType] Mime type of the content, with charset etc.
Binding: IHE MimeType (required)
..... language 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
..... url 1..1 url [DocumentEntry.URI] Uri where the data can be found
..... size S 0..1 unsignedInt [DocumentEntry.size] Number of bytes of content
..... hash S 0..1 base64Binary [DocumentEntry.hash] Hash of the data (sha-1)
..... title S 1..1 string [DocumentEntry.title] The readable title of the document
..... creation 1..1 dateTime [DocumentEntry.creationTime] Date attachment was first created
.... format 1..1 Coding [DocumentEntry.formatCode] Format/content rules for the document
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... context S 1..1 BackboneElement Clinical context of document
.... event S 0..* CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
..... coding
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
.... period 0..1 Period [DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime] Time of service that is being documented
..... start S 0..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType 1..1 CodeableConcept [DocumentEntry.healthcareFacilityTypeCode] Kind of facility where patient was seen
..... coding
...... system S 1..1 uri Identity of the terminology system
Binding: IHE HealthcareFacilityTypeCode (extensible)
...... code S 1..1 code Symbol in syntax defined by the system
.... practiceSetting 1..1 CodeableConcept [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty)
..... coding
...... system S 1..1 uri Identity of the terminology system
Binding: IHE PracticeSettingCode (extensible)
...... code S 1..1 code Symbol in syntax defined by the system
.... sourcePatientInfo 1..1 Reference(MedComDocumentPatient) [DocumentEntry.sourcePatientId and DocumentEntry.sourcePatientInfo] Patient demographics from source. Must be the same reference as in DocumentReference.subject.
.... related S 0..* Reference(Resource) [DocumentEntry.referenceIdList] Related identifiers or resources

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.category Base extensible IHE ClassCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.contentType Base required IHE MimeType 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.language Base extensible IHE LanguageCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​facilityType.coding.​system Base extensible IHE HealthcareFacilityTypeCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​practiceSetting.coding.​system Base extensible IHE PracticeSettingCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0

Constraints

Id Grade Path(s) Description Expression
uuid error DocumentReference.identifier General UUID expression value.matches('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MedComMinimalDocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionid 1..1 string Specifies the version of the DocumentReference profile for a standard.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:homeCommunityid S 1..1 Coding [DocumentEntry.homeCommunityId] A unique identifier for a community where the DocumentEntry and document can be accessed
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-homecommunityid-extension
... masterIdentifier S 1..1 UniqueIdIdentifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... Slices for identifier SΣC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
Slice: Unordered, Open by value:use
Constraints: uuid
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:entryUUID 0..1 EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: MHD DocumentReference status codes (required)
... type SΣ 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
Binding: DocumentTypeValueSet (preferred): Precise type of clinical 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
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 1..1 CodeableConcept [DocumentEntry.class] Categorization of document
Binding: IHE ClassCode (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(MedComDocumentPatient) {c} [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... Slices for author SΣ 1..2 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) {c} [DocumentEntry.author] Who and/or what authored the document
Slice: Unordered, Closed by type:$this.resolve()
.... author:institution SΣ 1..1 Reference(MedComDocumentOrganization) {c} [DocumentEntry.author.authorInstitution] The organization who authored the document
.... author:person SΣ 0..1 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 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 Σ 0..1 string Human-readable description
... securityLabel SΣ 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... content SΣ 1..1 BackboneElement Document referenced
.... 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 SΣ 1..1 code [DocumentEntry.mimeType] Mime type of the content, with charset etc.
Binding: IHE MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
Example General: en-AU
..... url Σ 1..1 url [DocumentEntry.URI] Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt [DocumentEntry.size] Number of bytes of content
..... hash SΣ 0..1 base64Binary [DocumentEntry.hash] Hash of the data (sha-1)
..... title SΣ 1..1 string [DocumentEntry.title] The readable title of the document
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime [DocumentEntry.creationTime] Date attachment was first created
.... format SΣ 1..1 Coding [DocumentEntry.formatCode] Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... context SΣ 1..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 S 0..* CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: ActCode (3.0.0) (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... period SΣ 0..1 Period [DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime] Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 1..1 CodeableConcept [DocumentEntry.healthcareFacilityTypeCode] Kind of facility where patient was seen
Binding: DK SOR Organization Type (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE HealthcareFacilityTypeCode (extensible)
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... practiceSetting S 1..1 CodeableConcept [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty)
Binding: Replication og DK SOR Practice Setting Code (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE PracticeSettingCode (extensible)
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... sourcePatientInfo S 1..1 Reference(MedComDocumentPatient) [DocumentEntry.sourcePatientId and DocumentEntry.sourcePatientInfo] Patient demographics from source. Must be the same reference as in DocumentReference.subject.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... related S 0..* Reference(Resource) [DocumentEntry.referenceIdList] Related identifiers or resources

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.masterIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.masterIdentifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
DocumentReference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.2 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base extensible IHE ClassCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
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 IHE MimeType 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.language Base extensible IHE LanguageCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📦1.2.0 IHE FormatCode Vocabulary v1.2
DocumentReference.context.​event Base required v3 Code System ActCode 📍3.0.0 THO v7.0
DocumentReference.context.​facilityType Base extensible DK SOR Organization Type 📦3.4.0 HL7 FHIR Implementation Guide: DK Core v3.4
DocumentReference.context.​facilityType.coding.​system Base extensible IHE HealthcareFacilityTypeCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​practiceSetting Base extensible Replication og DK SOR Practice Setting Code 📦1.0.1 This IG
DocumentReference.context.​practiceSetting.coding.​system Base extensible IHE PracticeSettingCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
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()
uuid error DocumentReference.identifier General UUID expression value.matches('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MedComMinimalDocumentReference A reference to a document
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionid 1..1 string Specifies the version of the DocumentReference profile for a standard.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:homeCommunityid S 1..1 Coding [DocumentEntry.homeCommunityId] A unique identifier for a community where the DocumentEntry and document can be accessed
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-homecommunityid-extension
... masterIdentifier S 1..1 UniqueIdIdentifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... value SΣ 1..1 string The value that is unique
Example General: 123456
.... identifier:entryUUID 0..1 EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: MHD DocumentReference status codes (required)
... type SΣ 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
... category SΣ 1..1 CodeableConcept [DocumentEntry.class] Categorization of document
Binding: IHE ClassCode (extensible)
.... coding Σ 0..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
... subject SΣ 1..1 Reference(MedComDocumentPatient) {c} [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... Slices for author SΣ 1..2 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) {c} [DocumentEntry.author] Who and/or what authored the document
Slice: Unordered, Closed by type:$this.resolve()
.... author:institution SΣ 1..1 Reference(MedComDocumentOrganization) {c} [DocumentEntry.author.authorInstitution] The organization who authored the document
.... author:person SΣ 0..1 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... 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
... securityLabel SΣ 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
... content SΣ 1..1 BackboneElement Document referenced
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType SΣ 1..1 code [DocumentEntry.mimeType] Mime type of the content, with charset etc.
Binding: IHE MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
Example General: en-AU
..... url Σ 1..1 url [DocumentEntry.URI] Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt [DocumentEntry.size] Number of bytes of content
..... hash SΣ 0..1 base64Binary [DocumentEntry.hash] Hash of the data (sha-1)
..... title SΣ 1..1 string [DocumentEntry.title] The readable title of the document
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime [DocumentEntry.creationTime] Date attachment was first created
.... format SΣ 1..1 Coding [DocumentEntry.formatCode] Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..* CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: ActCode (3.0.0) (required)
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... period SΣ 0..1 Period [DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime] Time of service that is being documented
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 1..1 CodeableConcept [DocumentEntry.healthcareFacilityTypeCode] Kind of facility where patient was seen
Binding: DK SOR Organization Type (extensible)
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE HealthcareFacilityTypeCode (extensible)
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... practiceSetting S 1..1 CodeableConcept [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty)
Binding: Replication og DK SOR Practice Setting Code (extensible)
..... coding Σ 0..* Coding Code defined by a terminology system
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE PracticeSettingCode (extensible)
...... code SΣ 1..1 code Symbol in syntax defined by the system
.... sourcePatientInfo S 1..1 Reference(MedComDocumentPatient) [DocumentEntry.sourcePatientId and DocumentEntry.sourcePatientInfo] Patient demographics from source. Must be the same reference as in DocumentReference.subject.
.... related S 0..* Reference(Resource) [DocumentEntry.referenceIdList] Related identifiers or resources

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.masterIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.2 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base extensible IHE ClassCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
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 IHE MimeType 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.language Base extensible IHE LanguageCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📦1.2.0 IHE FormatCode Vocabulary v1.2
DocumentReference.context.​event Base required v3 Code System ActCode 📍3.0.0 THO v7.0
DocumentReference.context.​facilityType Base extensible DK SOR Organization Type 📦3.4.0 HL7 FHIR Implementation Guide: DK Core v3.4
DocumentReference.context.​facilityType.coding.​system Base extensible IHE HealthcareFacilityTypeCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​practiceSetting Base extensible Replication og DK SOR Practice Setting Code 📦1.0.1 This IG
DocumentReference.context.​practiceSetting.coding.​system Base extensible IHE PracticeSettingCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0

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()
uuid error DocumentReference.identifier General UUID expression value.matches('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')

Differential View

This structure is derived from MedComMinimalDocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MedComMinimalDocumentReference A reference to a document
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:homeCommunityid S 1..1 Coding [DocumentEntry.homeCommunityId] A unique identifier for a community where the DocumentEntry and document can be accessed
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-homecommunityid-extension
... masterIdentifier S 1..1 UniqueIdIdentifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... value S 1..1 string The value that is unique
.... value S 1..1 string The value that is unique
... Slices for identifier Content/Rules for all slices
.... identifier:entryUUID 0..1 EntryUUIDIdentifier An identifier intended for computation
... status S 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
... type 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
... category 1..1 CodeableConcept [DocumentEntry.class] Categorization of document
Binding: IHE ClassCode (extensible)
.... coding
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
... subject 1..1 Reference(MedComDocumentPatient) {c} [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document
... Slices for author 1..2 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) {c} [DocumentEntry.author] Who and/or what authored the document
Slice: Unordered, Closed by type:$this.resolve()
.... author:institution S 1..1 Reference(MedComDocumentOrganization) {c} [DocumentEntry.author.authorInstitution] The organization who authored the document
.... author:person S 0..1 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... securityLabel 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
... content S 1..1 BackboneElement Document referenced
.... attachment
..... contentType S 1..1 code [DocumentEntry.mimeType] Mime type of the content, with charset etc.
Binding: IHE MimeType (required)
..... language 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
..... url 1..1 url [DocumentEntry.URI] Uri where the data can be found
..... size S 0..1 unsignedInt [DocumentEntry.size] Number of bytes of content
..... hash S 0..1 base64Binary [DocumentEntry.hash] Hash of the data (sha-1)
..... title S 1..1 string [DocumentEntry.title] The readable title of the document
..... creation 1..1 dateTime [DocumentEntry.creationTime] Date attachment was first created
.... format 1..1 Coding [DocumentEntry.formatCode] Format/content rules for the document
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... context S 1..1 BackboneElement Clinical context of document
.... event S 0..* CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
..... coding
...... system S 1..1 uri Identity of the terminology system
...... code S 1..1 code Symbol in syntax defined by the system
.... period 0..1 Period [DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime] Time of service that is being documented
..... start S 0..1 dateTime Starting time with inclusive boundary
..... end S 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType 1..1 CodeableConcept [DocumentEntry.healthcareFacilityTypeCode] Kind of facility where patient was seen
..... coding
...... system S 1..1 uri Identity of the terminology system
Binding: IHE HealthcareFacilityTypeCode (extensible)
...... code S 1..1 code Symbol in syntax defined by the system
.... practiceSetting 1..1 CodeableConcept [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty)
..... coding
...... system S 1..1 uri Identity of the terminology system
Binding: IHE PracticeSettingCode (extensible)
...... code S 1..1 code Symbol in syntax defined by the system
.... sourcePatientInfo 1..1 Reference(MedComDocumentPatient) [DocumentEntry.sourcePatientId and DocumentEntry.sourcePatientInfo] Patient demographics from source. Must be the same reference as in DocumentReference.subject.
.... related S 0..* Reference(Resource) [DocumentEntry.referenceIdList] Related identifiers or resources

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.category Base extensible IHE ClassCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.contentType Base required IHE MimeType 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.language Base extensible IHE LanguageCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​facilityType.coding.​system Base extensible IHE HealthcareFacilityTypeCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​practiceSetting.coding.​system Base extensible IHE PracticeSettingCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0

Constraints

Id Grade Path(s) Description Expression
uuid error DocumentReference.identifier General UUID expression value.matches('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference 0..* MedComMinimalDocumentReference A reference to a document
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 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".
... 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionid 1..1 string Specifies the version of the DocumentReference profile for a standard.
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version
.... extension:homeCommunityid S 1..1 Coding [DocumentEntry.homeCommunityId] A unique identifier for a community where the DocumentEntry and document can be accessed
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-homecommunityid-extension
... masterIdentifier S 1..1 UniqueIdIdentifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Required Pattern: usual
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... Slices for identifier SΣC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
Slice: Unordered, Open by value:use
Constraints: uuid
.... identifier:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:entryUUID 0..1 EntryUUIDIdentifier An identifier intended for computation
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: MHD DocumentReference status codes (required)
... type SΣ 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
Binding: DocumentTypeValueSet (preferred): Precise type of clinical 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
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... category SΣ 1..1 CodeableConcept [DocumentEntry.class] Categorization of document
Binding: IHE ClassCode (extensible)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(MedComDocumentPatient) {c} [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document
... date SΣ 0..1 instant When this document reference was created
... Slices for author SΣ 1..2 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) {c} [DocumentEntry.author] Who and/or what authored the document
Slice: Unordered, Closed by type:$this.resolve()
.... author:institution SΣ 1..1 Reference(MedComDocumentOrganization) {c} [DocumentEntry.author.authorInstitution] The organization who authored the document
.... author:person SΣ 0..1 Reference(Danish Core Patient Profile | Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Related Person Profile | Danish Core Organization Profile | Device) [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(Danish Core Practitioner Profile | Danish Core PractitionerRole Profile | Danish Core Organization Profile) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... custodian 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 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 Σ 0..1 string Human-readable description
... securityLabel SΣ 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... content SΣ 1..1 BackboneElement Document referenced
.... 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 SΣ 1..1 code [DocumentEntry.mimeType] Mime type of the content, with charset etc.
Binding: IHE MimeType (required)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
Example General: en-AU
..... url Σ 1..1 url [DocumentEntry.URI] Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size SΣ 0..1 unsignedInt [DocumentEntry.size] Number of bytes of content
..... hash SΣ 0..1 base64Binary [DocumentEntry.hash] Hash of the data (sha-1)
..... title SΣ 1..1 string [DocumentEntry.title] The readable title of the document
Example General: Official Corporate Logo
..... creation SΣ 1..1 dateTime [DocumentEntry.creationTime] Date attachment was first created
.... format SΣ 1..1 Coding [DocumentEntry.formatCode] Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... context SΣ 1..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 S 0..* CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: ActCode (3.0.0) (required)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... period SΣ 0..1 Period [DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime] Time of service that is being documented
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start SΣC 0..1 dateTime Starting time with inclusive boundary
..... end SΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
.... facilityType S 1..1 CodeableConcept [DocumentEntry.healthcareFacilityTypeCode] Kind of facility where patient was seen
Binding: DK SOR Organization Type (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE HealthcareFacilityTypeCode (extensible)
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... practiceSetting S 1..1 CodeableConcept [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty)
Binding: Replication og DK SOR Practice Setting Code (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system SΣ 1..1 uri Identity of the terminology system
Binding: IHE PracticeSettingCode (extensible)
...... version Σ 0..1 string Version of the system - if relevant
...... code SΣ 1..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... sourcePatientInfo S 1..1 Reference(MedComDocumentPatient) [DocumentEntry.sourcePatientId and DocumentEntry.sourcePatientInfo] Patient demographics from source. Must be the same reference as in DocumentReference.subject.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 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).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... related S 0..* Reference(Resource) [DocumentEntry.referenceIdList] Related identifiers or resources

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.masterIdentifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.masterIdentifier.​type Base extensible IdentifierType 📦4.0.1 FHIR Std.
DocumentReference.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
DocumentReference.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
DocumentReference.status Base required MHD DocumentReference status codes 📦4.2.2 Mobile access to Health Documents v4.2
DocumentReference.type Base preferred Document Type Value Set 📦4.0.1 FHIR Std.
DocumentReference.category Base extensible IHE ClassCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
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 IHE MimeType 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​attachment.language Base extensible IHE LanguageCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.content.​format Base preferred IHE ValueSet of Format Codes for use with Document Sharing 📦1.2.0 IHE FormatCode Vocabulary v1.2
DocumentReference.context.​event Base required v3 Code System ActCode 📍3.0.0 THO v7.0
DocumentReference.context.​facilityType Base extensible DK SOR Organization Type 📦3.4.0 HL7 FHIR Implementation Guide: DK Core v3.4
DocumentReference.context.​facilityType.coding.​system Base extensible IHE HealthcareFacilityTypeCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
DocumentReference.context.​practiceSetting Base extensible Replication og DK SOR Practice Setting Code 📦1.0.1 This IG
DocumentReference.context.​practiceSetting.coding.​system Base extensible IHE PracticeSettingCode 📦1.0.1 Dk Terminology for XDS Metadata v1.0
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()
uuid error DocumentReference.identifier General UUID expression value.matches('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}')

 

Other representations of profile: CSV, Excel, Schematron