Danish XDS Documents profiles
2.0.0 - ci-build
Danish XDS Documents profiles
2.0.0 - ci-build
Danish XDS Documents profiles, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 2.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-xds-documents/ and changes regularly. See the Directory of published versions
| Official URL: https://medcomfhir.dk/ig/xdsdocuments/StructureDefinition/medcom-contained-documentreference | Version: 2.0.0 | |||
| Draft as of 2026-01-06 | 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:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  DocumentReference |
0..* | MedComMinimalDocumentReference | A reference to a document | |
  id |
SΣ | 1..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  text |
S | 0..1 | Narrative | The narrative text SHALL always be included when exchanging a MedCom FHIR Bundle. This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
 status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
 div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
 Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
  extension:versionid |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version |
| masterIdentifier |
SΣ | 1..1 | UniqueIdIdentifier | [DocumentEntry.uniqueId] Master Version Specific Identifier |
| use |
?!Σ | 1..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 |
 Slices for identifier |
SΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use |
 identifier:entryUUID |
SΣ | 1..1 | EntryUUIDIdentifier | [DocumentEntry.entryUUID] Identifier for the document |
  use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
 value |
SΣC | 1..1 | string | The value that is unique Constraints: mhd-startswithuuid, medcom-uuid Example General: 123456 |
| 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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS (required) |
 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 |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| category |
SΣ | 1..1 | CodeableConcept | [DocumentEntry.classCode] Categorization of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS (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 |
| display |
SΣ | 1..1 | string | Representation 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(MedComDocumentOrganization | MedComDocumentPractitioner | MedComDocumentPatient | Danish Core Related Person Profile(3.5.0) | Device) {b} | [DocumentEntry.author] The slice author:institution ensures one mandatory organizational author.
Any author element that does not match this slice is interpreted
as an author person. Slice: Unordered, Open by profile:$this.resolve() |
| author:institution |
SΣ | 1..1 | Reference(MedComDocumentOrganization) | The organization who authored the document. |
| authenticator |
S | 0..1 | Reference(MedComDocumentPractitioner) {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..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..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 |
SΣ | 1..1 | Attachment | Where to access the document |
| contentType |
SΣ | 1..1 | code | [DocumentEntry.mimeType] Mime type of the content, with charset etc. Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS (required) Example General: text/plain; charset=UTF-8, image/png |
| language |
SΣ | 1..1 | code | [DocumentEntry.languageCode] Human language of the content Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS (extensible) Example General: en-AU |
| url |
SΣ | 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ΣC | 1..1 | dateTime | [DocumentEntry.creationTime] Date attachment was first created Constraints: medcom-datetime-has-time-zulu |
| format |
SΣ | 1..1 | Coding | [DocumentEntry.formatCode] Format/content rules for the document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS (required) |
| 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) (example) |
| 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 | 1..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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS (required) |
| coding |
SΣ | 1..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 |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| practiceSetting |
S | 1..1 | CodeableConcept | [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty). Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS (required) |
| coding |
SΣ | 1..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 |
| display |
SΣ | 1..1 | string | Representation 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. |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| related |
S | 0..* | Reference(Resource) | [DocumentEntry.referenceIdList] Related identifiers or resources. |
| Documentation for this format | ||||
| 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()
|
| medcom-datetime-has-time-zulu | error | DocumentReference.content.attachment.creation | dateTime must include date, time, and time zone. |
$this.toString().matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]+)?Z$')
|
| medcom-uuid | error | DocumentReference.identifier:entryUUID.value | The value shall correspond to the structure of an UUID |
$this.matches('(?i)^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[45][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
| mhd-startswithuuid | error | DocumentReference.identifier:entryUUID.value | value must start with urn:uuid: |
startsWith('urn:uuid:')
|
| txt-1 | error | DocumentReference.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | DocumentReference.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from MedComMinimalDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | MedComMinimalDocumentReference | A reference to a document | |
 id |
S | 1..1 | id | Logical id of this artifact |
| text |
S | 0..1 | Narrative | The narrative text SHALL always be included when exchanging a MedCom FHIR Bundle. |
| status |
S | 1..1 | code | generated | extensions | additional | empty |
| div |
S | 1..1 | xhtml | Limited xhtml content |
| extension |
S | 1..* | Extension | Extension |
| Slices for extension |
Content/Rules for all slices | |||
| extension:versionid |
S | 1..1 | R5 DocumentReference.version | Extension |
| masterIdentifier |
S | 1..1 | UniqueIdIdentifier | [DocumentEntry.uniqueId] Master Version Specific Identifier |
| value |
S | 1..1 | string | The value that is unique |
| identifier |
1..* | Identifier | Other identifiers for the document | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:entryUUID |
1..1 | EntryUUIDIdentifier | [DocumentEntry.entryUUID] Identifier for the document | |
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
SC | 1..1 | string | The value that is unique Constraints: medcom-uuid |
| status |
S | 1..1 | code | [DocumentEntry.availabilityStatus] current = active | superseded = deprecated |
| type |
1..1 | CodeableConcept | [DocumentEntry.typeCode] Kind of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS (required) | |
| 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 |
| display |
S | 1..1 | string | Representation defined by the system |
| category |
1..1 | CodeableConcept | [DocumentEntry.classCode] Categorization of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS (extensible) | |
| coding |
||||
| 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 |
| subject |
1..1 | Reference(MedComDocumentPatient) {c} | [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document | |
| Slices for author |
1..2 | Reference(MedComDocumentOrganization | MedComDocumentPractitioner | MedComDocumentPatient | Danish Core Related Person Profile(3.5.0) | Device) {b} | [DocumentEntry.author] The slice author:institution ensures one mandatory organizational author.
Any author element that does not match this slice is interpreted
as an author person. Slice: Unordered, Open by profile:$this.resolve() | |
| author:institution |
S | 1..1 | Reference(MedComDocumentOrganization) | The organization who authored the document. |
| authenticator |
S | 0..1 | Reference(MedComDocumentPractitioner) {c} | [DocumentEntry.legalAuthenticator] Who authenticated the document. |
| securityLabel |
1..1 | CodeableConcept | [DocumentEntry.confidentialityCode] Document security-tags | |
| coding |
S | 1..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 |
S | 1..1 | Attachment | Where to access the document |
| contentType |
S | 1..1 | code | [DocumentEntry.mimeType] Mime type of the content, with charset etc. Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS (required) |
| language |
1..1 | code | [DocumentEntry.languageCode] Human language of the content Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS (extensible) | |
| url |
S | 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 |
C | 1..1 | dateTime | [DocumentEntry.creationTime] Date attachment was first created Constraints: medcom-datetime-has-time-zulu |
| format |
1..1 | Coding | [DocumentEntry.formatCode] Format/content rules for the document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS (required) | |
| 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 | 1..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. Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS (required) | |
| coding |
S | 1..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 |
| display |
S | 1..1 | string | Representation defined by the system |
| practiceSetting |
1..1 | CodeableConcept | [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty). Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS (required) | |
| coding |
S | 1..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 |
| display |
S | 1..1 | string | Representation 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. | |
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| related |
S | 0..* | Reference(Resource) | [DocumentEntry.referenceIdList] Related identifiers or resources. |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| medcom-datetime-has-time-zulu | error | DocumentReference.content.attachment.creation | dateTime must include date, time, and time zone. |
$this.toString().matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]+)?Z$')
|
| medcom-uuid | error | DocumentReference.identifier:entryUUID.value | The value shall correspond to the structure of an UUID |
$this.matches('(?i)^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[45][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | MedComMinimalDocumentReference | A reference to a document | |||||
| id |
SΣ | 1..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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 0..1 | Narrative | The narrative text SHALL always be included when exchanging a MedCom FHIR Bundle. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| extension:versionid |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version | ||||
| 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 |
?!Σ | 1..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Σ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use | ||||
| identifier:entryUUID |
SΣ | 1..1 | EntryUUIDIdentifier | [DocumentEntry.entryUUID] Identifier for 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 | |||||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
| 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 |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value |
SΣC | 1..1 | string | The value that is unique Constraints: mhd-startswithuuid, medcom-uuid 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: MHD DocumentReference status codes (required) | ||||
| type |
SΣ | 1..1 | CodeableConcept | [DocumentEntry.typeCode] Kind of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS (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 |
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 |
SΣ | 1..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.classCode] Categorization of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS (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 |
SΣ | 1..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(MedComDocumentOrganization | MedComDocumentPractitioner | MedComDocumentPatient | Danish Core Related Person Profile(3.5.0) | Device) {b} | [DocumentEntry.author] The slice author:institution ensures one mandatory organizational author.
Any author element that does not match this slice is interpreted
as an author person. Slice: Unordered, Open by profile:$this.resolve() | ||||
| author:institution |
SΣ | 1..1 | Reference(MedComDocumentOrganization) | The organization 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 |
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..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..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 |
SΣ | 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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS (required) Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
SΣ | 1..1 | code | [DocumentEntry.languageCode] Human language of the content Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS (extensible) Example General: en-AU | ||||
| url |
SΣ | 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ΣC | 1..1 | dateTime | [DocumentEntry.creationTime] Date attachment was first created Constraints: medcom-datetime-has-time-zulu | ||||
| format |
SΣ | 1..1 | Coding | [DocumentEntry.formatCode] Format/content rules for the document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS (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 | |||||
| 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) (example) | ||||
| 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 | 1..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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS (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 |
SΣ | 1..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 |
SΣ | 1..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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS (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 |
SΣ | 1..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 |
SΣ | 1..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 |
SΣC | 1..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 |
SΣ | 1..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. | ||||
| Documentation for this format | ||||||||
| 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.text.status | Base | required | NarrativeStatus | 📍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:entryUUID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| DocumentReference.identifier:entryUUID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS | Not State | Unknown |
| DocumentReference.category | Base | extensible | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS | Not State | Unknown |
| 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 | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS | Not State | Unknown |
| DocumentReference.content.attachment.language | Base | extensible | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS | Not State | Unknown |
| DocumentReference.content.format | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS | Not State | Unknown |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📍3.0.0 | THO v7.0 |
| DocumentReference.context.facilityType | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS | Not State | Unknown |
| DocumentReference.context.practiceSetting | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS | Not State | Unknown |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| medcom-datetime-has-time-zulu | error | DocumentReference.content.attachment.creation | dateTime must include date, time, and time zone. |
$this.toString().matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]+)?Z$')
|
| medcom-uuid | error | DocumentReference.identifier:entryUUID.value | The value shall correspond to the structure of an UUID |
$this.matches('(?i)^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[45][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
| mhd-startswithuuid | error | DocumentReference.identifier:entryUUID.value | value must start with urn:uuid: |
startsWith('urn:uuid:')
|
| txt-1 | error | DocumentReference.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | DocumentReference.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from MedComMinimalDocumentReference
Summary
Mandatory: 35 elements(6 nested mandatory elements)
Must-Support: 50 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | MedComMinimalDocumentReference | A reference to a document | |
| id |
SΣ | 1..1 | id | Logical id of this artifact |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
S | 0..1 | Narrative | The narrative text SHALL always be included when exchanging a MedCom FHIR Bundle. This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. |
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 |
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| extension:versionid |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version |
| masterIdentifier |
SΣ | 1..1 | UniqueIdIdentifier | [DocumentEntry.uniqueId] Master Version Specific Identifier |
| use |
?!Σ | 1..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 |
| Slices for identifier |
SΣ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use |
| identifier:entryUUID |
SΣ | 1..1 | EntryUUIDIdentifier | [DocumentEntry.entryUUID] Identifier for the document |
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
| system |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 |
| value |
SΣC | 1..1 | string | The value that is unique Constraints: mhd-startswithuuid, medcom-uuid Example General: 123456 |
| 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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS (required) |
| 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 |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| category |
SΣ | 1..1 | CodeableConcept | [DocumentEntry.classCode] Categorization of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS (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 |
| display |
SΣ | 1..1 | string | Representation 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(MedComDocumentOrganization | MedComDocumentPractitioner | MedComDocumentPatient | Danish Core Related Person Profile(3.5.0) | Device) {b} | [DocumentEntry.author] The slice author:institution ensures one mandatory organizational author.
Any author element that does not match this slice is interpreted
as an author person. Slice: Unordered, Open by profile:$this.resolve() |
| author:institution |
SΣ | 1..1 | Reference(MedComDocumentOrganization) | The organization who authored the document. |
| authenticator |
S | 0..1 | Reference(MedComDocumentPractitioner) {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..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..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 |
SΣ | 1..1 | Attachment | Where to access the document |
| contentType |
SΣ | 1..1 | code | [DocumentEntry.mimeType] Mime type of the content, with charset etc. Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS (required) Example General: text/plain; charset=UTF-8, image/png |
| language |
SΣ | 1..1 | code | [DocumentEntry.languageCode] Human language of the content Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS (extensible) Example General: en-AU |
| url |
SΣ | 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ΣC | 1..1 | dateTime | [DocumentEntry.creationTime] Date attachment was first created Constraints: medcom-datetime-has-time-zulu |
| format |
SΣ | 1..1 | Coding | [DocumentEntry.formatCode] Format/content rules for the document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS (required) |
| 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) (example) |
| 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 | 1..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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS (required) |
| coding |
SΣ | 1..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 |
| display |
SΣ | 1..1 | string | Representation defined by the system |
| practiceSetting |
S | 1..1 | CodeableConcept | [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty). Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS (required) |
| coding |
SΣ | 1..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 |
| display |
SΣ | 1..1 | string | Representation 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. |
| reference |
SΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
SΣ | 1..1 | Identifier | Logical reference, when literal reference is not known |
| related |
S | 0..* | Reference(Resource) | [DocumentEntry.referenceIdList] Related identifiers or resources. |
| Documentation for this format | ||||
| 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()
|
| medcom-datetime-has-time-zulu | error | DocumentReference.content.attachment.creation | dateTime must include date, time, and time zone. |
$this.toString().matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]+)?Z$')
|
| medcom-uuid | error | DocumentReference.identifier:entryUUID.value | The value shall correspond to the structure of an UUID |
$this.matches('(?i)^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[45][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
| mhd-startswithuuid | error | DocumentReference.identifier:entryUUID.value | value must start with urn:uuid: |
startsWith('urn:uuid:')
|
| txt-1 | error | DocumentReference.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | DocumentReference.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
Differential View
This structure is derived from MedComMinimalDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| DocumentReference |
0..* | MedComMinimalDocumentReference | A reference to a document | |
| id |
S | 1..1 | id | Logical id of this artifact |
| text |
S | 0..1 | Narrative | The narrative text SHALL always be included when exchanging a MedCom FHIR Bundle. |
| status |
S | 1..1 | code | generated | extensions | additional | empty |
| div |
S | 1..1 | xhtml | Limited xhtml content |
| extension |
S | 1..* | Extension | Extension |
| Slices for extension |
Content/Rules for all slices | |||
| extension:versionid |
S | 1..1 | R5 DocumentReference.version | Extension |
| masterIdentifier |
S | 1..1 | UniqueIdIdentifier | [DocumentEntry.uniqueId] Master Version Specific Identifier |
| value |
S | 1..1 | string | The value that is unique |
| identifier |
1..* | Identifier | Other identifiers for the document | |
| Slices for identifier |
Content/Rules for all slices | |||
| identifier:entryUUID |
1..1 | EntryUUIDIdentifier | [DocumentEntry.entryUUID] Identifier for the document | |
| system |
S | 1..1 | uri | The namespace for the identifier value |
| value |
SC | 1..1 | string | The value that is unique Constraints: medcom-uuid |
| status |
S | 1..1 | code | [DocumentEntry.availabilityStatus] current = active | superseded = deprecated |
| type |
1..1 | CodeableConcept | [DocumentEntry.typeCode] Kind of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS (required) | |
| 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 |
| display |
S | 1..1 | string | Representation defined by the system |
| category |
1..1 | CodeableConcept | [DocumentEntry.classCode] Categorization of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS (extensible) | |
| coding |
||||
| 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 |
| subject |
1..1 | Reference(MedComDocumentPatient) {c} | [DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId] Who/what is the subject of the document | |
| Slices for author |
1..2 | Reference(MedComDocumentOrganization | MedComDocumentPractitioner | MedComDocumentPatient | Danish Core Related Person Profile(3.5.0) | Device) {b} | [DocumentEntry.author] The slice author:institution ensures one mandatory organizational author.
Any author element that does not match this slice is interpreted
as an author person. Slice: Unordered, Open by profile:$this.resolve() | |
| author:institution |
S | 1..1 | Reference(MedComDocumentOrganization) | The organization who authored the document. |
| authenticator |
S | 0..1 | Reference(MedComDocumentPractitioner) {c} | [DocumentEntry.legalAuthenticator] Who authenticated the document. |
| securityLabel |
1..1 | CodeableConcept | [DocumentEntry.confidentialityCode] Document security-tags | |
| coding |
S | 1..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 |
S | 1..1 | Attachment | Where to access the document |
| contentType |
S | 1..1 | code | [DocumentEntry.mimeType] Mime type of the content, with charset etc. Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS (required) |
| language |
1..1 | code | [DocumentEntry.languageCode] Human language of the content Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS (extensible) | |
| url |
S | 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 |
C | 1..1 | dateTime | [DocumentEntry.creationTime] Date attachment was first created Constraints: medcom-datetime-has-time-zulu |
| format |
1..1 | Coding | [DocumentEntry.formatCode] Format/content rules for the document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS (required) | |
| 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 | 1..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. Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS (required) | |
| coding |
S | 1..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 |
| display |
S | 1..1 | string | Representation defined by the system |
| practiceSetting |
1..1 | CodeableConcept | [DocumentEntry.practiceSettingCode] Additional details about where the content was created (e.g. clinical specialty). Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS (required) | |
| coding |
S | 1..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 |
| display |
S | 1..1 | string | Representation 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. | |
| reference |
S | 1..1 | string | Literal reference, Relative, internal or absolute URL |
| identifier |
S | 1..1 | Identifier | Logical reference, when literal reference is not known |
| related |
S | 0..* | Reference(Resource) | [DocumentEntry.referenceIdList] Related identifiers or resources. |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| medcom-datetime-has-time-zulu | error | DocumentReference.content.attachment.creation | dateTime must include date, time, and time zone. |
$this.toString().matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]+)?Z$')
|
| medcom-uuid | error | DocumentReference.identifier:entryUUID.value | The value shall correspond to the structure of an UUID |
$this.matches('(?i)^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[45][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| DocumentReference |
0..* | MedComMinimalDocumentReference | A reference to a document | |||||
| id |
SΣ | 1..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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text |
S | 0..1 | Narrative | The narrative text SHALL always be included when exchanging a MedCom FHIR Bundle. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
S | 1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | ||||
| div |
SC | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| Slices for extension |
S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| extension:versionid |
S | 1..1 | string | Extension URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-DocumentReference.version | ||||
| 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 |
?!Σ | 1..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Σ | 1..* | Identifier | Other identifiers for the document Slice: Unordered, Open by value:use | ||||
| identifier:entryUUID |
SΣ | 1..1 | EntryUUIDIdentifier | [DocumentEntry.entryUUID] Identifier for 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 | |||||
| use |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
| 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 |
SΣ | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:ietf:rfc:3986 | ||||
| value |
SΣC | 1..1 | string | The value that is unique Constraints: mhd-startswithuuid, medcom-uuid 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: MHD DocumentReference status codes (required) | ||||
| type |
SΣ | 1..1 | CodeableConcept | [DocumentEntry.typeCode] Kind of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS (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 |
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 |
SΣ | 1..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.classCode] Categorization of document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS (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 |
SΣ | 1..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(MedComDocumentOrganization | MedComDocumentPractitioner | MedComDocumentPatient | Danish Core Related Person Profile(3.5.0) | Device) {b} | [DocumentEntry.author] The slice author:institution ensures one mandatory organizational author.
Any author element that does not match this slice is interpreted
as an author person. Slice: Unordered, Open by profile:$this.resolve() | ||||
| author:institution |
SΣ | 1..1 | Reference(MedComDocumentOrganization) | The organization 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 |
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..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..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 |
SΣ | 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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS (required) Example General: text/plain; charset=UTF-8, image/png | ||||
| language |
SΣ | 1..1 | code | [DocumentEntry.languageCode] Human language of the content Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS (extensible) Example General: en-AU | ||||
| url |
SΣ | 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ΣC | 1..1 | dateTime | [DocumentEntry.creationTime] Date attachment was first created Constraints: medcom-datetime-has-time-zulu | ||||
| format |
SΣ | 1..1 | Coding | [DocumentEntry.formatCode] Format/content rules for the document Binding: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS (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 | |||||
| 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) (example) | ||||
| 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 | 1..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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS (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 |
SΣ | 1..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 |
SΣ | 1..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: http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS (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 |
SΣ | 1..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 |
SΣ | 1..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 |
SΣC | 1..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 |
SΣ | 1..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. | ||||
| Documentation for this format | ||||||||
| 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.text.status | Base | required | NarrativeStatus | 📍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:entryUUID.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| DocumentReference.identifier:entryUUID.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.3 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-typecode-VS | Not State | Unknown |
| DocumentReference.category | Base | extensible | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-classcode-VS | Not State | Unknown |
| 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 | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-mimeType-VS | Not State | Unknown |
| DocumentReference.content.attachment.language | Base | extensible | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-languagecode-VS | Not State | Unknown |
| DocumentReference.content.format | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-formatcode-VS | Not State | Unknown |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📍3.0.0 | THO v7.0 |
| DocumentReference.context.facilityType | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-HealthcareFacilityTypeCode-VS | Not State | Unknown |
| DocumentReference.context.practiceSetting | Base | required | http://medcomfhir.dk/ig/xdsmetadata/ValueSet/MedCom-xds-PracticeSettingCode-VS | Not State | Unknown |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| 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()
|
| medcom-datetime-has-time-zulu | error | DocumentReference.content.attachment.creation | dateTime must include date, time, and time zone. |
$this.toString().matches('^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]+)?Z$')
|
| medcom-uuid | error | DocumentReference.identifier:entryUUID.value | The value shall correspond to the structure of an UUID |
$this.matches('(?i)^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[45][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$')
|
| mhd-startswithuuid | error | DocumentReference.identifier:entryUUID.value | value must start with urn:uuid: |
startsWith('urn:uuid:')
|
| txt-1 | error | DocumentReference.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | DocumentReference.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from MedComMinimalDocumentReference
Summary
Mandatory: 35 elements(6 nested mandatory elements)
Must-Support: 50 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron