Dit profiel is het resultaat van de vergelijking tussen de zib2017 STU3 en zibs2020 R4 FHIR Profiel, relevante informatiestandarden en de implementaties in de ontsloten systemen en instellingen. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.

View Definition

ViewDefinition voor Correspondentie

UI Wireframe

Correspondentie

Gegevensherkomst

Document soorten herkennen

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

Request

1. Opvragen (search) alle documenten

   GET <ontsluiten-bronsysteem-base>/DocumentReference?patient=<fhir_patient_id>&status=current

CGM: Ondersteunt de generieke query. CGM gebruikt een eigen masterIdentifier systeem (http://cgmhuisarts.cgm.nl/fhir/NamingSystem/DocumentReferenceMasterID).

Bronsysteem herkennen

De Zorgviewer-backend of Ontsluiten bronsysteem MOET na bevragen van het bronsysteem aan elk resultaat resource een meta-tag toevoegen met de AGB, OID of URA identifier van de zorgaanbieder (zie Organization voor voorbeelden). Dit wordt vervolgens gebruikt in de "Bron" kolom in de Zorgviewer-frontend. N.B. We gebruiken hier een pre-adopt van de FHIR R4 Meta.source.

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

"meta": {
    "extension": [ {
        "url": "http://hl7.org/fhir/4.0/StructureDefinition/extension-Meta.source",
        "valueUri": "urn:oid:2.16.840.1.113883.2.4.3.8"
    } ]
}

Alternatief: Elke entry van een search response Bundle bevat een referentie naar de bijbehorende Patient (<resource>.subject|patient). Elke patient heeft een Patient.managingOrganization en in de gerefereerde Organization.identifier staat vervolgens o.a. de OID van het bronsysyeem. Of je gebruikt de identifiers om een volledige Organization op te zoeken in het adresboek en zie inhoud hier.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	Nictiz.IHE.MHD.Minimal.DocumentReference	A reference to a document Constraints: zv-dr-1
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.masterIdentifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	Master Version Specific Identifier
DocumentReference.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Other identifiers for the document
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Class & Type waardelijst (extensible)
DocumentReference.class	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Categorization of document Binding: Document Class & Type waardelijst (extensible)
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
DocumentReference.indexed	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When this document reference was created
DocumentReference.author	S This element must be supported. Σ This element is included in summaries.	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
DocumentReference.relatesTo	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target	Σ This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	S This element must be supported. Σ This element is included in summaries.	0..1	string	Human-readable description (title)
DocumentReference.securityLabel	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries. C	1..1	Attachment	Where to access the document Constraints: zv-dr-2
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..1	code	Mime 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
DocumentReference.content.attachment.language	S This element must be supported. Σ This element is included in summaries.	0..1	code	Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
DocumentReference.content.attachment.url	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
DocumentReference.content.format	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.
DocumentReference.context	Σ This element is included in summaries.	0..1	BackboneElement	Clinical context of document
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.context.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time of service that is being documented
DocumentReference.context.period.start	S This element must be supported. Σ This element is included in summaries. C	0..1	dateTime	Starting time with inclusive boundary
DocumentReference.context.facilityType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
DocumentReference.context.practiceSetting	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Additional 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).
DocumentReference.context.sourcePatientInfo	S This element must be supported. Σ This element is included in summaries.	0..1	Reference() {c}	Patient demographics from source
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.status	Base	required	DocumentReferenceStatus	📦3.0.2	FHIR Std.
DocumentReference.type	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.class	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.relatesTo.​code	Base	required	DocumentRelationshipType	📦3.0.2	FHIR Std.
DocumentReference.securityLabel	Base	extensible	All Security Labels	📦3.0.2	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	Mime Types	📦5.0.0	FHIR Extensions Pack v5.3
DocumentReference.content.​attachment.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
DocumentReference.content.​format	Base	preferred	IHE ValueSet of Format Codes for use with Document Sharing	📦20180126	Nictiz FHIR NL STU3 Zib2017 v2.3
DocumentReference.context.​facilityType	Base	example	Facility Type Code Value Set	📦20091109	FHIR Std.
DocumentReference.context.​practiceSetting	Base	example	Practice Setting Code Value Set	📦20091109	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
zv-dr-1	error	DocumentReference	Only documents with status 'current' (final documents) are expected.	status='current'
zv-dr-2	warning	DocumentReference.content.attachment	Only pdf documents are expected through the url	contentType='application/pdf'

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	Nictiz.IHE.MHD.Minimal.DocumentReference	A reference to a document Constraints: zv-dr-1
DocumentReference.status	S This element must be supported.	1..1	code	current | superseded | entered-in-error
DocumentReference.type	S This element must be supported.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Class & Type waardelijst (extensible)
DocumentReference.class	S This element must be supported.	0..1	CodeableConcept	Categorization of document Binding: Document Class & Type waardelijst (extensible)
DocumentReference.author	S This element must be supported.	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
DocumentReference.description	S This element must be supported.	0..1	string	Human-readable description (title)
DocumentReference.content	S This element must be supported.	1..1	BackboneElement	Document referenced
DocumentReference.content.attachment	S This element must be supported. C	1..1	Attachment	Where to access the document Constraints: zv-dr-2
DocumentReference.content.attachment.contentType	S This element must be supported.	1..1	code	Mime type of the content, with charset etc.
DocumentReference.content.attachment.url	S This element must be supported.	1..1	uri	Uri where the data can be found
DocumentReference.context
DocumentReference.context.period
DocumentReference.context.period.start	S This element must be supported.	0..1	dateTime	Starting time with inclusive boundary
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.type	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.class	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
zv-dr-1	error	DocumentReference	Only documents with status 'current' (final documents) are expected.	status='current'
zv-dr-2	warning	DocumentReference.content.attachment	Only pdf documents are expected through the url	contentType='application/pdf'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	Nictiz.IHE.MHD.Minimal.DocumentReference	A reference to a document Constraints: zv-dr-1
DocumentReference.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
DocumentReference.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
DocumentReference.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained		0..*	Resource	Contained, inline Resources
DocumentReference.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.masterIdentifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	Master Version Specific Identifier
DocumentReference.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Other identifiers for the document
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Class & Type waardelijst (extensible)
DocumentReference.class	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Categorization of document Binding: Document Class & Type waardelijst (extensible)
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
DocumentReference.indexed	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When this document reference was created
DocumentReference.author	S This element must be supported. Σ This element is included in summaries.	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
DocumentReference.authenticator	Σ This element is included in summaries.	0..1	Reference() {c}	Who/what authenticated the document
DocumentReference.relatesTo	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.relatesTo.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target	Σ This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	S This element must be supported. Σ This element is included in summaries.	0..1	string	Human-readable description (title)
DocumentReference.securityLabel	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.content.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries. C	1..1	Attachment	Where to access the document Constraints: zv-dr-2
DocumentReference.content.attachment.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.content.attachment.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..1	code	Mime 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
DocumentReference.content.attachment.language	S This element must be supported. Σ This element is included in summaries.	0..1	code	Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
DocumentReference.content.attachment.url	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size	Σ This element is included in summaries.	0..1	unsignedInt	Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash	Σ This element is included in summaries.	0..1	base64Binary	Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title	Σ This element is included in summaries.	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
DocumentReference.content.format	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.
DocumentReference.context	Σ This element is included in summaries.	0..1	BackboneElement	Clinical context of document
DocumentReference.context.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.context.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.context.encounter	Σ This element is included in summaries.	0..1	Reference(Encounter)	Context of the document content
DocumentReference.context.event	Σ This element is included in summaries.	0..*	CodeableConcept	Main clinical acts documented Binding: ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time of service that is being documented
DocumentReference.context.period.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.context.period.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.context.period.start	S This element must be supported. Σ This element is included in summaries. C	0..1	dateTime	Starting time with inclusive boundary
DocumentReference.context.period.end	Σ This element is included in summaries. C	0..1	dateTime	End time with inclusive boundary, if not ongoing
DocumentReference.context.facilityType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
DocumentReference.context.practiceSetting	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Additional 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).
DocumentReference.context.sourcePatientInfo	S This element must be supported. Σ This element is included in summaries.	0..1	Reference() {c}	Patient demographics from source
DocumentReference.context.related	Σ This element is included in summaries.	0..*	BackboneElement	Related identifiers or resources
DocumentReference.context.related.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.context.related.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.context.related.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.context.related.identifier	Σ This element is included in summaries.	0..1	Identifier	Identifier of related objects or events
DocumentReference.context.related.ref	Σ This element is included in summaries.	0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
DocumentReference.status	Base	required	DocumentReferenceStatus	📦3.0.2	FHIR Std.
DocumentReference.type	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.class	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.relatesTo.​code	Base	required	DocumentRelationshipType	📦3.0.2	FHIR Std.
DocumentReference.securityLabel	Base	extensible	All Security Labels	📦3.0.2	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	Mime Types	📦5.0.0	FHIR Extensions Pack v5.3
DocumentReference.content.​attachment.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
DocumentReference.content.​format	Base	preferred	IHE ValueSet of Format Codes for use with Document Sharing	📦20180126	Nictiz FHIR NL STU3 Zib2017 v2.3
DocumentReference.context.​event	Base	example	v3 Code System ActCode	📦2016-11-11	FHIR Std.
DocumentReference.context.​facilityType	Base	example	Facility Type Code Value Set	📦20091109	FHIR Std.
DocumentReference.context.​practiceSetting	Base	example	Practice Setting Code Value Set	📦20091109	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
zv-dr-1	error	DocumentReference	Only documents with status 'current' (final documents) are expected.	status='current'
zv-dr-2	warning	DocumentReference.content.attachment	Only pdf documents are expected through the url	contentType='application/pdf'

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	Nictiz.IHE.MHD.Minimal.DocumentReference	A reference to a document Constraints: zv-dr-1
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.masterIdentifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	Master Version Specific Identifier
DocumentReference.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Other identifiers for the document
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Class & Type waardelijst (extensible)
DocumentReference.class	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Categorization of document Binding: Document Class & Type waardelijst (extensible)
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
DocumentReference.indexed	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When this document reference was created
DocumentReference.author	S This element must be supported. Σ This element is included in summaries.	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
DocumentReference.relatesTo	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target	Σ This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	S This element must be supported. Σ This element is included in summaries.	0..1	string	Human-readable description (title)
DocumentReference.securityLabel	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries. C	1..1	Attachment	Where to access the document Constraints: zv-dr-2
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..1	code	Mime 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
DocumentReference.content.attachment.language	S This element must be supported. Σ This element is included in summaries.	0..1	code	Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
DocumentReference.content.attachment.url	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
DocumentReference.content.format	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.
DocumentReference.context	Σ This element is included in summaries.	0..1	BackboneElement	Clinical context of document
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.context.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time of service that is being documented
DocumentReference.context.period.start	S This element must be supported. Σ This element is included in summaries. C	0..1	dateTime	Starting time with inclusive boundary
DocumentReference.context.facilityType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
DocumentReference.context.practiceSetting	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Additional 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).
DocumentReference.context.sourcePatientInfo	S This element must be supported. Σ This element is included in summaries.	0..1	Reference() {c}	Patient demographics from source
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.status	Base	required	DocumentReferenceStatus	📦3.0.2	FHIR Std.
DocumentReference.type	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.class	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.relatesTo.​code	Base	required	DocumentRelationshipType	📦3.0.2	FHIR Std.
DocumentReference.securityLabel	Base	extensible	All Security Labels	📦3.0.2	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	Mime Types	📦5.0.0	FHIR Extensions Pack v5.3
DocumentReference.content.​attachment.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
DocumentReference.content.​format	Base	preferred	IHE ValueSet of Format Codes for use with Document Sharing	📦20180126	Nictiz FHIR NL STU3 Zib2017 v2.3
DocumentReference.context.​facilityType	Base	example	Facility Type Code Value Set	📦20091109	FHIR Std.
DocumentReference.context.​practiceSetting	Base	example	Practice Setting Code Value Set	📦20091109	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
zv-dr-1	error	DocumentReference	Only documents with status 'current' (final documents) are expected.	status='current'
zv-dr-2	warning	DocumentReference.content.attachment	Only pdf documents are expected through the url	contentType='application/pdf'

Differential View

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	Nictiz.IHE.MHD.Minimal.DocumentReference	A reference to a document Constraints: zv-dr-1
DocumentReference.status	S This element must be supported.	1..1	code	current | superseded | entered-in-error
DocumentReference.type	S This element must be supported.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Class & Type waardelijst (extensible)
DocumentReference.class	S This element must be supported.	0..1	CodeableConcept	Categorization of document Binding: Document Class & Type waardelijst (extensible)
DocumentReference.author	S This element must be supported.	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
DocumentReference.description	S This element must be supported.	0..1	string	Human-readable description (title)
DocumentReference.content	S This element must be supported.	1..1	BackboneElement	Document referenced
DocumentReference.content.attachment	S This element must be supported. C	1..1	Attachment	Where to access the document Constraints: zv-dr-2
DocumentReference.content.attachment.contentType	S This element must be supported.	1..1	code	Mime type of the content, with charset etc.
DocumentReference.content.attachment.url	S This element must be supported.	1..1	uri	Uri where the data can be found
DocumentReference.context
DocumentReference.context.period
DocumentReference.context.period.start	S This element must be supported.	0..1	dateTime	Starting time with inclusive boundary
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.type	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.class	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
zv-dr-1	error	DocumentReference	Only documents with status 'current' (final documents) are expected.	status='current'
zv-dr-2	warning	DocumentReference.content.attachment	Only pdf documents are expected through the url	contentType='application/pdf'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference	C	0..*	Nictiz.IHE.MHD.Minimal.DocumentReference	A reference to a document Constraints: zv-dr-1
DocumentReference.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
DocumentReference.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
DocumentReference.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
DocumentReference.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
DocumentReference.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
DocumentReference.contained		0..*	Resource	Contained, inline Resources
DocumentReference.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.masterIdentifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	Master Version Specific Identifier
DocumentReference.identifier	S This element must be supported. Σ This element is included in summaries.	0..*	Identifier	Other identifiers for the document
DocumentReference.status	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
DocumentReference.type	S This element must be supported. Σ This element is included in summaries.	1..1	CodeableConcept	Kind of document (LOINC if possible) Binding: Document Class & Type waardelijst (extensible)
DocumentReference.class	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Categorization of document Binding: Document Class & Type waardelijst (extensible)
DocumentReference.subject	S This element must be supported. Σ This element is included in summaries.	0..1	Reference(Patient) {r, b}	Who/what is the subject of the document
DocumentReference.indexed	S This element must be supported. Σ This element is included in summaries.	1..1	instant	When this document reference was created
DocumentReference.author	S This element must be supported. Σ This element is included in summaries.	0..*	Reference(Practitioner | Organization) {c}	Who and/or what authored the document
DocumentReference.authenticator	Σ This element is included in summaries.	0..1	Reference() {c}	Who/what authenticated the document
DocumentReference.relatesTo	?! This element is a modifier element. S This element must be supported. Σ This element is included in summaries.	0..*	BackboneElement	Relationships to other documents
DocumentReference.relatesTo.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.relatesTo.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.relatesTo.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.relatesTo.code	Σ This element is included in summaries.	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
DocumentReference.relatesTo.target	Σ This element is included in summaries.	1..1	Reference(DocumentReference)	Target of the relationship
DocumentReference.description	S This element must be supported. Σ This element is included in summaries.	0..1	string	Human-readable description (title)
DocumentReference.securityLabel	S This element must be supported. Σ This element is included in summaries.	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
DocumentReference.content	S This element must be supported. Σ This element is included in summaries.	1..1	BackboneElement	Document referenced
DocumentReference.content.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.content.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.content.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.content.attachment	S This element must be supported. Σ This element is included in summaries. C	1..1	Attachment	Where to access the document Constraints: zv-dr-2
DocumentReference.content.attachment.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.content.attachment.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.content.attachment.contentType	S This element must be supported. Σ This element is included in summaries.	1..1	code	Mime 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
DocumentReference.content.attachment.language	S This element must be supported. Σ This element is included in summaries.	0..1	code	Human language of the content (BCP-47) Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding Example General: en-AU
DocumentReference.content.attachment.url	S This element must be supported. Σ This element is included in summaries.	1..1	uri	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
DocumentReference.content.attachment.size	Σ This element is included in summaries.	0..1	unsignedInt	Number of bytes of content (if url provided)
DocumentReference.content.attachment.hash	Σ This element is included in summaries.	0..1	base64Binary	Hash of the data (sha-1, base64ed)
DocumentReference.content.attachment.title	Σ This element is included in summaries.	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
DocumentReference.content.format	S This element must be supported. Σ This element is included in summaries.	0..1	Coding	Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.
DocumentReference.context	Σ This element is included in summaries.	0..1	BackboneElement	Clinical context of document
DocumentReference.context.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.context.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.context.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.context.encounter	Σ This element is included in summaries.	0..1	Reference(Encounter)	Context of the document content
DocumentReference.context.event	Σ This element is included in summaries.	0..*	CodeableConcept	Main clinical acts documented Binding: ActCode (example): This list of codes represents the main clinical acts being documented.
DocumentReference.context.period	S This element must be supported. Σ This element is included in summaries.	0..1	Period	Time of service that is being documented
DocumentReference.context.period.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.context.period.extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
DocumentReference.context.period.start	S This element must be supported. Σ This element is included in summaries. C	0..1	dateTime	Starting time with inclusive boundary
DocumentReference.context.period.end	Σ This element is included in summaries. C	0..1	dateTime	End time with inclusive boundary, if not ongoing
DocumentReference.context.facilityType	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Kind of facility where patient was seen Binding: Facility Type Code Value Set (example): XDS Facility Type.
DocumentReference.context.practiceSetting	S This element must be supported. Σ This element is included in summaries.	0..1	CodeableConcept	Additional 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).
DocumentReference.context.sourcePatientInfo	S This element must be supported. Σ This element is included in summaries.	0..1	Reference() {c}	Patient demographics from source
DocumentReference.context.related	Σ This element is included in summaries.	0..*	BackboneElement	Related identifiers or resources
DocumentReference.context.related.id		0..1	string	xml:id (or equivalent in JSON)
DocumentReference.context.related.extension		0..*	Extension	Additional Content defined by implementations
DocumentReference.context.related.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
DocumentReference.context.related.identifier	Σ This element is included in summaries.	0..1	Identifier	Identifier of related objects or events
DocumentReference.context.related.ref	Σ This element is included in summaries.	0..1	Reference(Resource)	Related Resource
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
DocumentReference.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
DocumentReference.status	Base	required	DocumentReferenceStatus	📦3.0.2	FHIR Std.
DocumentReference.type	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.class	Base	extensible	Document Class & Type waardelijst	📦1.27.0	This IG
DocumentReference.relatesTo.​code	Base	required	DocumentRelationshipType	📦3.0.2	FHIR Std.
DocumentReference.securityLabel	Base	extensible	All Security Labels	📦3.0.2	FHIR Std.
DocumentReference.content.​attachment.contentType	Base	required	Mime Types	📦5.0.0	FHIR Extensions Pack v5.3
DocumentReference.content.​attachment.language	Base	extensible	Common Languages	📦3.0.2	FHIR Std.
DocumentReference.content.​format	Base	preferred	IHE ValueSet of Format Codes for use with Document Sharing	📦20180126	Nictiz FHIR NL STU3 Zib2017 v2.3
DocumentReference.context.​event	Base	example	v3 Code System ActCode	📦2016-11-11	FHIR Std.
DocumentReference.context.​facilityType	Base	example	Facility Type Code Value Set	📦20091109	FHIR Std.
DocumentReference.context.​practiceSetting	Base	example	Practice Setting Code Value Set	📦20091109	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	DocumentReference	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
zv-dr-1	error	DocumentReference	Only documents with status 'current' (final documents) are expected.	status='current'
zv-dr-2	warning	DocumentReference.content.attachment	Only pdf documents are expected through the url	contentType='application/pdf'

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

Summary

Mandatory: 1 element
Must-Support: 10 elements