RIVO Noord Zorgviewer MVP2 Implementation Guide
0.2.1 - CI build Netherlands flag

RIVO Noord Zorgviewer MVP2 Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions

Resource Profile: DocumentReference

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/DocumentReference Version: 0.2.1
Draft as of 2023-03-22 Computable Name: DocumentReference

The minimal DocumentReference for the Zorgviewer

Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic en Chipsoft. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

Bronsysteem herkennen

De Zorgviewer-backend ZOU na bevragen van het bronsysteem aan elk resultaat resource een meta-tag MOETEN toevoegen met de VEKTIZ code van de zorgaanbieder, zodat dit kan worden gebruikt in de presentatie in de Zorgviewer-frontend.

Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):

{ ...
  "meta": {
    "tag": [
      { "system": "http://hl7.nl/fhir/zorgviewer-ig/bronsysteem-zorgaanbieder",
        "code": "06020101",
        "display": "UMCG"
      } ] }
  ... }

Document soorten herkennen

class (higher level grouping) type (http://loinc.org) descriptions
Correspondentie 56444-3 Healthcare communication Document Correspondentie, Patiëntenbrief, Verwijsbrief, Poliklinische brief, Artsenbrief
Imaging result 28570-0 Procedure note Radiologie verslag
Notitie ? ?

Zie het Excelbestand tab “classCode+decision tree” voor LOINC codes: Nationale XDS metadataset

Request: <ontsluiten-bronsysteem-base>/DocumentReference?patient=<fhir_patient_id>

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 Nictiz.IHE.MHD.Minimal.DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*Nictiz.IHE.MHD.Minimal.DocumentReferenceA reference to a document
... status SC1..1codecurrent | superseded | entered-in-error
zv-dr-1: Only status is curreent final documents are expected.
... type S1..1CodeableConceptKind of document (LOINC if possible)
... class S0..1CodeableConceptCategorization of document
... author S0..*Reference(Practitioner | Organization) {c}Who and/or what authored the document
... description S0..1stringHuman-readable description (title)
... content 1..1BackboneElementDocument referenced
.... attachment SC1..1AttachmentWhere to access the document
zv-dr-2: Only pdf documents are expected through the url
..... contentType S1..1codeMime type of the content, with charset etc.
..... url S1..1uriUri where the data can be found

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
zv-dr-1errorDocumentReference.statusOnly status is curreent final documents are expected.
: status='current'
zv-dr-2warningDocumentReference.content.attachmentOnly pdf documents are expected through the url
: content.attachement.contentType='application/pdf'
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*Nictiz.IHE.MHD.Minimal.DocumentReferenceA reference to a document
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier SΣ1..1IdentifierMaster Version Specific Identifier
... status ?!SΣC1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.


zv-dr-1: Only status is curreent final documents are expected.
... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.

... class SΣ0..1CodeableConceptCategorization of document
Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.

... subject SΣ0..1Reference(Patient) {r, b}Who/what is the subject of the document
... indexed SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference(Practitioner | Organization) {c}Who and/or what authored the document
... relatesTo ?!SΣ0..*BackboneElementRelationships to other documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1stringHuman-readable description (title)
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..1BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... attachment SΣC1..1AttachmentWhere to access the document
zv-dr-2: Only pdf documents are expected through the url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language SΣ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... format SΣ0..1CodingFormat/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ0..1BackboneElementClinical context of document
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... period SΣ0..1PeriodTime of service that is being documented
.... facilityType SΣ0..1CodeableConceptKind of facility where patient was seen
Binding: Facility Type Code Value Set (example): XDS Facility Type.

.... practiceSetting SΣ0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo SΣ0..1Reference() {c}Patient demographics from source

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.typepreferredDocument Type Value Set
DocumentReference.classexampleDocument Class Value Set
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleAll Security Labels
DocumentReference.content.attachment.contentTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE.FormatCode.vs (a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3)
DocumentReference.context.facilityTypeexampleFacility Type Code Value Set
DocumentReference.context.practiceSettingexamplePractice Setting Code Value Set

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
zv-dr-1errorDocumentReference.statusOnly status is curreent final documents are expected.
: status='current'
zv-dr-2warningDocumentReference.content.attachmentOnly pdf documents are expected through the url
: content.attachement.contentType='application/pdf'
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*Nictiz.IHE.MHD.Minimal.DocumentReferenceA reference to a document
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier SΣ1..1IdentifierMaster Version Specific Identifier
... identifier SΣ0..*IdentifierOther identifiers for the document
... status ?!SΣC1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.


zv-dr-1: Only status is curreent final documents are expected.
... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.

... class SΣ0..1CodeableConceptCategorization of document
Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.

... subject SΣ0..1Reference(Patient) {r, b}Who/what is the subject of the document
... indexed SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference(Practitioner | Organization) {c}Who and/or what authored the document
... authenticator Σ0..1Reference() {c}Who/what authenticated the document
... relatesTo ?!SΣ0..*BackboneElementRelationships to other documents
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1stringHuman-readable description (title)
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..1BackboneElementDocument referenced
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... attachment SΣC1..1AttachmentWhere to access the document
zv-dr-2: Only pdf documents are expected through the url
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language SΣ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... format SΣ0..1CodingFormat/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ0..1BackboneElementClinical context of document
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... encounter Σ0..1Reference(Encounter)Context of the document content
.... event Σ0..*CodeableConceptMain clinical acts documented
Binding: ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ0..1PeriodTime of service that is being documented
.... facilityType SΣ0..1CodeableConceptKind of facility where patient was seen
Binding: Facility Type Code Value Set (example): XDS Facility Type.

.... practiceSetting SΣ0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo SΣ0..1Reference() {c}Patient demographics from source
.... related Σ0..*BackboneElementRelated identifiers or resources
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... identifier Σ0..1IdentifierIdentifier of related objects or events
..... ref Σ0..1Reference(Resource)Related Resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.typepreferredDocument Type Value Set
DocumentReference.classexampleDocument Class Value Set
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleAll Security Labels
DocumentReference.content.attachment.contentTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE.FormatCode.vs (a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3)
DocumentReference.context.eventexamplev3 Code System ActCode
DocumentReference.context.facilityTypeexampleFacility Type Code Value Set
DocumentReference.context.practiceSettingexamplePractice Setting Code Value Set

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
zv-dr-1errorDocumentReference.statusOnly status is curreent final documents are expected.
: status='current'
zv-dr-2warningDocumentReference.content.attachmentOnly pdf documents are expected through the url
: content.attachement.contentType='application/pdf'

This structure is derived from Nictiz.IHE.MHD.Minimal.DocumentReference

Summary

Mandatory: 1 element
Must-Support: 9 elements

Differential View

This structure is derived from Nictiz.IHE.MHD.Minimal.DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*Nictiz.IHE.MHD.Minimal.DocumentReferenceA reference to a document
... status SC1..1codecurrent | superseded | entered-in-error
zv-dr-1: Only status is curreent final documents are expected.
... type S1..1CodeableConceptKind of document (LOINC if possible)
... class S0..1CodeableConceptCategorization of document
... author S0..*Reference(Practitioner | Organization) {c}Who and/or what authored the document
... description S0..1stringHuman-readable description (title)
... content 1..1BackboneElementDocument referenced
.... attachment SC1..1AttachmentWhere to access the document
zv-dr-2: Only pdf documents are expected through the url
..... contentType S1..1codeMime type of the content, with charset etc.
..... url S1..1uriUri where the data can be found

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
zv-dr-1errorDocumentReference.statusOnly status is curreent final documents are expected.
: status='current'
zv-dr-2warningDocumentReference.content.attachmentOnly pdf documents are expected through the url
: content.attachement.contentType='application/pdf'

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*Nictiz.IHE.MHD.Minimal.DocumentReferenceA reference to a document
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier SΣ1..1IdentifierMaster Version Specific Identifier
... status ?!SΣC1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.


zv-dr-1: Only status is curreent final documents are expected.
... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.

... class SΣ0..1CodeableConceptCategorization of document
Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.

... subject SΣ0..1Reference(Patient) {r, b}Who/what is the subject of the document
... indexed SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference(Practitioner | Organization) {c}Who and/or what authored the document
... relatesTo ?!SΣ0..*BackboneElementRelationships to other documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1stringHuman-readable description (title)
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..1BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... attachment SΣC1..1AttachmentWhere to access the document
zv-dr-2: Only pdf documents are expected through the url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language SΣ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
.... format SΣ0..1CodingFormat/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ0..1BackboneElementClinical context of document
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... period SΣ0..1PeriodTime of service that is being documented
.... facilityType SΣ0..1CodeableConceptKind of facility where patient was seen
Binding: Facility Type Code Value Set (example): XDS Facility Type.

.... practiceSetting SΣ0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo SΣ0..1Reference() {c}Patient demographics from source

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.typepreferredDocument Type Value Set
DocumentReference.classexampleDocument Class Value Set
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleAll Security Labels
DocumentReference.content.attachment.contentTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE.FormatCode.vs (a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3)
DocumentReference.context.facilityTypeexampleFacility Type Code Value Set
DocumentReference.context.practiceSettingexamplePractice Setting Code Value Set

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
zv-dr-1errorDocumentReference.statusOnly status is curreent final documents are expected.
: status='current'
zv-dr-2warningDocumentReference.content.attachmentOnly pdf documents are expected through the url
: content.attachement.contentType='application/pdf'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*Nictiz.IHE.MHD.Minimal.DocumentReferenceA reference to a document
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... masterIdentifier SΣ1..1IdentifierMaster Version Specific Identifier
... identifier SΣ0..*IdentifierOther identifiers for the document
... status ?!SΣC1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.


zv-dr-1: Only status is curreent final documents are expected.
... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: Document Type Value Set (preferred): Precise type of clinical document.

... class SΣ0..1CodeableConceptCategorization of document
Binding: Document Class Value Set (example): High-level kind of a clinical document at a macro level.

... subject SΣ0..1Reference(Patient) {r, b}Who/what is the subject of the document
... indexed SΣ1..1instantWhen this document reference was created
... author SΣ0..*Reference(Practitioner | Organization) {c}Who and/or what authored the document
... authenticator Σ0..1Reference() {c}Who/what authenticated the document
... relatesTo ?!SΣ0..*BackboneElementRelationships to other documents
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... code Σ1..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1stringHuman-readable description (title)
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..1BackboneElementDocument referenced
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... attachment SΣC1..1AttachmentWhere to access the document
zv-dr-2: Only pdf documents are expected through the url
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: mimetypes (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
..... language SΣ0..1codeHuman language of the content (BCP-47)
Binding: Common Languages (extensible): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
..... url SΣ1..1uriUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
.... format SΣ0..1CodingFormat/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
... context Σ0..1BackboneElementClinical context of document
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... encounter Σ0..1Reference(Encounter)Context of the document content
.... event Σ0..*CodeableConceptMain clinical acts documented
Binding: ActCode (example): This list of codes represents the main clinical acts being documented.


.... period SΣ0..1PeriodTime of service that is being documented
.... facilityType SΣ0..1CodeableConceptKind of facility where patient was seen
Binding: Facility Type Code Value Set (example): XDS Facility Type.

.... practiceSetting SΣ0..1CodeableConceptAdditional details about where the content was created (e.g. clinical specialty)
Binding: Practice Setting Code Value Set (example): Additional details about where the content was created (e.g. clinical specialty).

.... sourcePatientInfo SΣ0..1Reference() {c}Patient demographics from source
.... related Σ0..*BackboneElementRelated identifiers or resources
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... identifier Σ0..1IdentifierIdentifier of related objects or events
..... ref Σ0..1Reference(Resource)Related Resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DocumentReference.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.typepreferredDocument Type Value Set
DocumentReference.classexampleDocument Class Value Set
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleAll Security Labels
DocumentReference.content.attachment.contentTyperequiredhttp://hl7.org/fhir/ValueSet/mimetypes
DocumentReference.content.attachment.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE.FormatCode.vs (a valid code from urn:oid:1.3.6.1.4.1.19376.1.2.3)
DocumentReference.context.eventexamplev3 Code System ActCode
DocumentReference.context.facilityTypeexampleFacility Type Code Value Set
DocumentReference.context.practiceSettingexamplePractice Setting Code Value Set

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
zv-dr-1errorDocumentReference.statusOnly status is curreent final documents are expected.
: status='current'
zv-dr-2warningDocumentReference.content.attachmentOnly pdf documents are expected through the url
: content.attachement.contentType='application/pdf'

This structure is derived from Nictiz.IHE.MHD.Minimal.DocumentReference

Summary

Mandatory: 1 element
Must-Support: 9 elements

 

Other representations of profile: CSV, Excel, Schematron