Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.5) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: CMSTemplateDocumentReference

A DocumentReference FHIR Resource that defines a template for communication. Content is sliced into template-message-body, template-message-parameters and template-attachment-file.

A Record Of Template used by different healthcare services for communication

Usages:

• Refer to this Profile: CMS Communication Request
• Examples for this Profile: DocumentReference/EmailCommunicationTemplateExample
• CapabilityStatements using this Profile: Shared Care FHIR Server Capability Statement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
category	Σ	1..*	CodeableConcept	Categorization of document Binding: Valueset for Template Category (required)
date	Σ	1..1	instant	When this document reference was created
Slices for content	Σ	1..*	BackboneElement	Document referenced Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension').value
content:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
content:template-message-body	Σ	1..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/html
content:template-message-parameters	Σ	0..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
content:template-attachment-file	Σ	0..*	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard
DocumentReference.category	required	TemplateCategoryValueSet(a valid code from Codes for Template category) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-template-category-valueset From this IG
DocumentReference.content:template-message-body.extension:contentType.value[x]	required	Pattern Value: body https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-body.attachment.contentType	required	Pattern Value: text/html http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-message-parameters.extension:contentType.value[x]	required	Pattern Value: parameters https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-parameters.attachment.contentType	required	Pattern Value: application/json http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-attachment-file.extension:contentType.value[x]	required	Pattern Value: attachment https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
meta		1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
docStatus		1..1	code	preliminary | final | amended | entered-in-error
category		1..*	CodeableConcept	Categorization of document Binding: Valueset for Template Category (required)
date		1..1	instant	When this document reference was created
Slices for content		1..*	BackboneElement	Document referenced Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension').value
content:template-message-body		1..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
value[x]		0..1	code	Value of extension Required Pattern: body
attachment
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: text/html
content:template-message-parameters		0..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
value[x]		0..1	code	Value of extension Required Pattern: parameters
attachment
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: application/json
content:template-attachment-file		0..*	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
value[x]		0..1	code	Value of extension Required Pattern: attachment
attachment
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.category	required	TemplateCategoryValueSet(a valid code from Codes for Template category) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-template-category-valueset From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..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	Σ	1..1	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.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
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	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	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
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	Σ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category	Σ	1..*	CodeableConcept	Categorization of document Binding: Valueset for Template Category (required)
subject	Σ	0..1	Reference(Patient | Practitioner | Group | Device)	Who/what is the subject of the document
date	Σ	1..1	instant	When this document reference was created
author	Σ	0..*	Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document
custodian		0..1	Reference(Organization)	Organization which maintains the document
relatesTo	Σ	0..*	BackboneElement	Relationships to other documents
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship
description	Σ	0..1	string	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for content	Σ	1..*	BackboneElement	Document referenced Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension').value
content:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
content:template-message-body	Σ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/html
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
content:template-message-parameters	Σ	0..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
content:template-attachment-file	Σ	0..*	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context	Σ	0..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		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	Σ	0..1	Period	Time of service that is being documented
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
DocumentReference.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard
DocumentReference.type	preferred	DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes From the FHIR Standard
DocumentReference.category	required	TemplateCategoryValueSet(a valid code from Codes for Template category) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-template-category-valueset From this IG
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
DocumentReference.content.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.content:template-message-body.extension:contentType.value[x]	required	Pattern Value: body https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-body.attachment.contentType	required	Pattern Value: text/html http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-message-body.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content:template-message-body.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.content:template-message-parameters.extension:contentType.value[x]	required	Pattern Value: parameters https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-parameters.attachment.contentType	required	Pattern Value: application/json http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-message-parameters.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content:template-message-parameters.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.content:template-attachment-file.extension:contentType.value[x]	required	Pattern Value: attachment https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-attachment-file.attachment.contentType	required	Mime Types(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-attachment-file.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content:template-attachment-file.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from DocumentReference

Summary

Mandatory: 12 elements(4 nested mandatory elements)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of DocumentReference.meta.tag
• The element 1 is sliced based on the value of DocumentReference.content

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
system	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code	Σ	1..1	code	Symbol in syntax defined by the system
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
category	Σ	1..*	CodeableConcept	Categorization of document Binding: Valueset for Template Category (required)
date	Σ	1..1	instant	When this document reference was created
Slices for content	Σ	1..*	BackboneElement	Document referenced Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension').value
content:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
content:template-message-body	Σ	1..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/html
content:template-message-parameters	Σ	0..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
content:template-attachment-file	Σ	0..*	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard
DocumentReference.category	required	TemplateCategoryValueSet(a valid code from Codes for Template category) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-template-category-valueset From this IG
DocumentReference.content:template-message-body.extension:contentType.value[x]	required	Pattern Value: body https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-body.attachment.contentType	required	Pattern Value: text/html http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-message-parameters.extension:contentType.value[x]	required	Pattern Value: parameters https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-parameters.attachment.contentType	required	Pattern Value: application/json http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-attachment-file.extension:contentType.value[x]	required	Pattern Value: attachment https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

Differential View

This structure is derived from DocumentReference

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
meta		1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
Slices for tag		1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:correlationId		1..1	Coding	Tags applied to this resource
system		1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
code		1..1	code	Symbol in syntax defined by the system
docStatus		1..1	code	preliminary | final | amended | entered-in-error
category		1..*	CodeableConcept	Categorization of document Binding: Valueset for Template Category (required)
date		1..1	instant	When this document reference was created
Slices for content		1..*	BackboneElement	Document referenced Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension').value
content:template-message-body		1..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
value[x]		0..1	code	Value of extension Required Pattern: body
attachment
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: text/html
content:template-message-parameters		0..1	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
value[x]		0..1	code	Value of extension Required Pattern: parameters
attachment
contentType		0..1	code	Mime type of the content, with charset etc. Required Pattern: application/json
content:template-attachment-file		0..*	BackboneElement	Document referenced
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
value[x]		0..1	code	Value of extension Required Pattern: attachment
attachment
Slices for extension				Content/Rules for all slices
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
DocumentReference.category	required	TemplateCategoryValueSet(a valid code from Codes for Template category) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-template-category-valueset From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
DocumentReference		0..*	DocumentReference	A reference to a document
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	1..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	Σ	1..1	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.
Slices for tag	Σ	1..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:correlationId	Σ	1..1	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".
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	Σ	1..1	uri	Hub correlation ID system Required Pattern: https://hub.services.digital.health.nz/ns/correlation-id
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	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
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
masterIdentifier	Σ	0..1	Identifier	Master Version Specific Identifier
identifier	Σ	0..*	Identifier	Other identifiers for the document
status	?!Σ	1..1	code	current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference.
docStatus	Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document.
type	Σ	0..1	CodeableConcept	Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.
category	Σ	1..*	CodeableConcept	Categorization of document Binding: Valueset for Template Category (required)
subject	Σ	0..1	Reference(Patient | Practitioner | Group | Device)	Who/what is the subject of the document
date	Σ	1..1	instant	When this document reference was created
author	Σ	0..*	Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)	Who and/or what authored the document
authenticator		0..1	Reference(Practitioner | PractitionerRole | Organization)	Who/what authenticated the document
custodian		0..1	Reference(Organization)	Organization which maintains the document
relatesTo	Σ	0..*	BackboneElement	Relationships to other documents
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target	Σ	1..1	Reference(DocumentReference)	Target of the relationship
description	Σ	0..1	string	Human-readable description
securityLabel	Σ	0..*	CodeableConcept	Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for content	Σ	1..*	BackboneElement	Document referenced Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension').value
content:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
content:template-message-body	Σ	1..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: body
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: text/html
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
content:template-message-parameters	Σ	0..1	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: parameters
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/json
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
content:template-attachment-file	Σ	0..*	BackboneElement	Document referenced
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:contentType		1..1	(Complex)	CMS Template Content Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension"
value[x]		0..1	code	Value of extension Binding: CMS Template Content Type ValueSet (required) Required Pattern: attachment
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
attachment	Σ	1..1	Attachment	Where to access the document
id		0..1	string	Unique id for inter-element referencing
Slices for extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:AttachmentExtension		0..1	(Complex)	Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
contentType	Σ	0..1	code	Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding Example General: en-AU
data		0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Uri where the data can be found Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	unsignedInt	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
format	Σ	0..1	Coding	Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.
context	Σ	0..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		0..*	CodeableConcept	Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	Σ	0..1	Period	Time of service that is being documented
facilityType		0..1	CodeableConcept	Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
practiceSetting		0..1	CodeableConcept	Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).
sourcePatientInfo		0..1	Reference(Patient)	Patient demographics from source
related		0..*	Reference(Resource)	Related identifiers or resources
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
DocumentReference.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
DocumentReference.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.meta.tag:correlationId	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
DocumentReference.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.status	required	DocumentReferenceStatus http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard
DocumentReference.docStatus	required	CompositionStatus http://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard
DocumentReference.type	preferred	DocumentTypeValueSet http://hl7.org/fhir/ValueSet/c80-doc-typecodes From the FHIR Standard
DocumentReference.category	required	TemplateCategoryValueSet(a valid code from Codes for Template category) https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-template-category-valueset From this IG
DocumentReference.relatesTo.code	required	DocumentRelationshipType http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard
DocumentReference.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
DocumentReference.content.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.content:template-message-body.extension:contentType.value[x]	required	Pattern Value: body https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-body.attachment.contentType	required	Pattern Value: text/html http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-message-body.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content:template-message-body.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.content:template-message-parameters.extension:contentType.value[x]	required	Pattern Value: parameters https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-message-parameters.attachment.contentType	required	Pattern Value: application/json http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-message-parameters.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content:template-message-parameters.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.content:template-attachment-file.extension:contentType.value[x]	required	Pattern Value: attachment https://fhir-ig.digital.health.nz/shared-care/ValueSet/cms-template-content-type-vs From this IG
DocumentReference.content:template-attachment-file.attachment.contentType	required	Mime Types(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard
DocumentReference.content:template-attachment-file.attachment.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
DocumentReference.content:template-attachment-file.format	preferred	DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem) http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard
DocumentReference.context.event	example	ActCode http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.context.facilityType	example	FacilityTypeCodeValueSet http://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard
DocumentReference.context.practiceSetting	example	PracticeSettingCodeValueSet http://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()

This structure is derived from DocumentReference

Summary

Mandatory: 12 elements(4 nested mandatory elements)

Extensions

This structure refers to these extensions:

• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-template-content-type-extension
• https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of DocumentReference.meta.tag
• The element 1 is sliced based on the value of DocumentReference.content