DK MedCom Document
1.0.0 - release

DK MedCom Document, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 1.0.0 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: MedComDocumentReference

Official URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-documentreference Version: 1.0.0
Active as of 2024-11-15 Computable Name: MedComDocumentReference

A profile stating the rules, when exchanging a FHIR document.

Scope and usage

The MedComDocumentReference profile is not intented to be exchanges, but can be used for internal validation of metadata associated with a document. This profile provides metadata about a document, this can be CDA, FHIR or PDF. It holds the required metadata from the IHE XDS metadata standard, and a mapping between the two can be found on GitHub pages.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
.... versionid SΣ 1..1 string Specifies the version of the DocumentReference for a standard.
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-version-id-extension
... masterIdentifier S 1..1 Identifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... value S 1..1 string The value that is unique
... identifier SC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
uuid: General UUID expression
.... value S 1..1 string The value that is unique
... type S 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
.... coding
..... 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
..... 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
... Slices for author S 1..2 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {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(MedComDocumentPractitioner) {c} [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(MedComDocumentPractitioner) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... securityLabel S 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
... content S 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 S 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
..... url S 0..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] Label to display in place of the data
..... 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
... context S 1..1 BackboneElement Clinical context of document
.... event S 0..1 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 S 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 S 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 S 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 S 1..1 Reference(Patient) [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)

PathConformanceValueSetURI
DocumentReference.categoryextensibleMedComIHE_CoreClassCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-classcode-VS
from this IG
DocumentReference.content.attachment.contentTyperequiredMedComIHE_CoreMimeType
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-mimetype-VS
from this IG
DocumentReference.content.attachment.languageextensibleMedComIHE_CoreLanguageCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-languagecode-VS
from this IG
DocumentReference.context.facilityType.coding.systemextensibleMedComIHE_CoreHealthcareFacilityTypeCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-HealthcareFacilityTypeCode-VS
from this IG
DocumentReference.context.practiceSetting.coding.systemextensibleMedComIHE_CorePracticeSettingCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-PracticeSettingCode-VS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
uuiderrorDocumentReference.identifierGeneral 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 & Constraintsdoco
.. 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
.... versionid SΣ 1..1 string Specifies the version of the DocumentReference for a standard.
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-version-id-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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 SΣC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
uuid: General UUID expression
.... 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
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

.... 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
... 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
... Slices for author SΣ 1..2 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {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(MedComDocumentPractitioner) {c} [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(MedComDocumentPractitioner) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... securityLabel SΣ 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ 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 SΣ 0..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] Label to display in place of the data
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: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..1 CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


..... 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: FacilityTypeCodeValueSet (example): XDS Facility Type.

..... 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: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).

..... 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(Patient) [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

PathConformanceValueSetURI
DocumentReference.masterIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryextensibleMedComIHE_CoreClassCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-classcode-VS
from this IG
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMedComIHE_CoreMimeType
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-mimetype-VS
from this IG
DocumentReference.content.attachment.languageextensibleMedComIHE_CoreLanguageCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-languagecode-VS
from this IG
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.facilityType.coding.systemextensibleMedComIHE_CoreHealthcareFacilityTypeCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-HealthcareFacilityTypeCode-VS
from this IG
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.context.practiceSetting.coding.systemextensibleMedComIHE_CorePracticeSettingCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-PracticeSettingCode-VS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
uuiderrorDocumentReference.identifierGeneral 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 & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
.... versionid SΣ 1..1 string Specifies the version of the DocumentReference for a standard.
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-version-id-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier SΣ 1..1 Identifier [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 .

.... 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 SΣC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
uuid: General UUID expression
.... 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)
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... 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 Σ 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
... 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 Σ 0..1 instant When this document reference was created
... Slices for author SΣ 1..2 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {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(MedComDocumentPractitioner) {c} [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(MedComDocumentPractitioner) {c} [DocumentEntry.legalAuthenticator] Who 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 Σ 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.


... content SΣ 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
..... data 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..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] Label to display in place of the data
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: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... 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..1 CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts 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
..... 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: FacilityTypeCodeValueSet (example): XDS Facility Type.

..... 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: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).

..... 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(Patient) [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

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.masterIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.masterIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryextensibleMedComIHE_CoreClassCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-classcode-VS
from this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMedComIHE_CoreMimeType
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-mimetype-VS
from this IG
DocumentReference.content.attachment.languageextensibleMedComIHE_CoreLanguageCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-languagecode-VS
from this IG
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.facilityType.coding.systemextensibleMedComIHE_CoreHealthcareFacilityTypeCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-HealthcareFacilityTypeCode-VS
from this IG
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.context.practiceSetting.coding.systemextensibleMedComIHE_CorePracticeSettingCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-PracticeSettingCode-VS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
uuiderrorDocumentReference.identifierGeneral 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 DocumentReference

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
.... versionid SΣ 1..1 string Specifies the version of the DocumentReference for a standard.
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-version-id-extension
... masterIdentifier S 1..1 Identifier [DocumentEntry.uniqueId] Master Version Specific Identifier
.... value S 1..1 string The value that is unique
... identifier SC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
uuid: General UUID expression
.... value S 1..1 string The value that is unique
... type S 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
.... coding
..... 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
..... 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
... Slices for author S 1..2 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {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(MedComDocumentPractitioner) {c} [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(MedComDocumentPractitioner) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... securityLabel S 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
... content S 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 S 1..1 code [DocumentEntry.languageCode] Human language of the content
Binding: IHE LanguageCode (extensible)
..... url S 0..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] Label to display in place of the data
..... 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
... context S 1..1 BackboneElement Clinical context of document
.... event S 0..1 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 S 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 S 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 S 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 S 1..1 Reference(Patient) [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)

PathConformanceValueSetURI
DocumentReference.categoryextensibleMedComIHE_CoreClassCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-classcode-VS
from this IG
DocumentReference.content.attachment.contentTyperequiredMedComIHE_CoreMimeType
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-mimetype-VS
from this IG
DocumentReference.content.attachment.languageextensibleMedComIHE_CoreLanguageCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-languagecode-VS
from this IG
DocumentReference.context.facilityType.coding.systemextensibleMedComIHE_CoreHealthcareFacilityTypeCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-HealthcareFacilityTypeCode-VS
from this IG
DocumentReference.context.practiceSetting.coding.systemextensibleMedComIHE_CorePracticeSettingCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-PracticeSettingCode-VS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
uuiderrorDocumentReference.identifierGeneral 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 & Constraintsdoco
.. 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 2..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
.... versionid SΣ 1..1 string Specifies the version of the DocumentReference for a standard.
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-version-id-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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 SΣC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
uuid: General UUID expression
.... 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
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: DocumentReferenceStatus (required): The status of the document reference.

... type SΣ 1..1 CodeableConcept [DocumentEntry.typeCode] Kind of document
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.

.... 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
... 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
... Slices for author SΣ 1..2 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {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(MedComDocumentPractitioner) {c} [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(MedComDocumentPractitioner) {c} [DocumentEntry.legalAuthenticator] Who authenticated the document
... securityLabel SΣ 1..* CodeableConcept [DocumentEntry.confidentialityCode] Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ 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 SΣ 0..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] Label to display in place of the data
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: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... context SΣ 1..1 BackboneElement Clinical context of document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... event S 0..1 CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


..... 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: FacilityTypeCodeValueSet (example): XDS Facility Type.

..... 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: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).

..... 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(Patient) [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

PathConformanceValueSetURI
DocumentReference.masterIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryextensibleMedComIHE_CoreClassCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-classcode-VS
from this IG
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMedComIHE_CoreMimeType
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-mimetype-VS
from this IG
DocumentReference.content.attachment.languageextensibleMedComIHE_CoreLanguageCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-languagecode-VS
from this IG
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.facilityType.coding.systemextensibleMedComIHE_CoreHealthcareFacilityTypeCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-HealthcareFacilityTypeCode-VS
from this IG
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.context.practiceSetting.coding.systemextensibleMedComIHE_CorePracticeSettingCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-PracticeSettingCode-VS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
uuiderrorDocumentReference.identifierGeneral 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 & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... 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
.... versionid SΣ 1..1 string Specifies the version of the DocumentReference for a standard.
URL: http://medcomfhir.dk/ig/document/StructureDefinition/medcom-document-version-id-extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... masterIdentifier SΣ 1..1 Identifier [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 .

.... 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 SΣC 1..1 Identifier [DocumentEntry.entryUUID] Identifier for the document
uuid: General UUID expression
.... 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)
... status ?!SΣ 1..1 code [DocumentEntry.availabilityStatus] current = active | superseded = deprecated
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus Σ 0..1 code preliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... 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 Σ 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
... 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 Σ 0..1 instant When this document reference was created
... Slices for author SΣ 1..2 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) {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(MedComDocumentPractitioner) {c} [DocumentEntry.author.authorPerson] The person who authored the document
... authenticator S 0..1 Reference(MedComDocumentPractitioner) {c} [DocumentEntry.legalAuthenticator] Who 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 Σ 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.


... content SΣ 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
..... data 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..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] Label to display in place of the data
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: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.

... 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..1 CodeableConcept [DocumentEntry.eventCodeList] Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts 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
..... 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: FacilityTypeCodeValueSet (example): XDS Facility Type.

..... 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: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).

..... 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(Patient) [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

PathConformanceValueSetURI
DocumentReference.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
DocumentReference.masterIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.masterIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
DocumentReference.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
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.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryextensibleMedComIHE_CoreClassCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-classcode-VS
from this IG
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMedComIHE_CoreMimeType
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-mimetype-VS
from this IG
DocumentReference.content.attachment.languageextensibleMedComIHE_CoreLanguageCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-languagecode-VS
from this IG
DocumentReference.content.formatpreferredDocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem)
http://hl7.org/fhir/ValueSet/formatcodes
from the FHIR Standard
DocumentReference.context.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.facilityType.coding.systemextensibleMedComIHE_CoreHealthcareFacilityTypeCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-HealthcareFacilityTypeCode-VS
from this IG
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.context.practiceSetting.coding.systemextensibleMedComIHE_CorePracticeSettingCode
http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-ihe-core-PracticeSettingCode-VS
from this IG

Constraints

IdGradePath(s)DetailsRequirements
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()
uuiderrorDocumentReference.identifierGeneral 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 DocumentReference

 

Other representations of profile: CSV, Excel, Schematron