Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.5 - release
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
| Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/TemplateDocumentReference | Version: 1.0.1 | |||
| Draft as of 2026-07-20 | Computable Name: TemplateDocumentReference | |||
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:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  DocumentReference |
0..* | 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 | |
 Slices for extension |
Content/Rules for all slices | |||
 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 | Extension Slice: Unordered, Open by value:url | ||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | Extension Slice: Unordered, Open by value:url | ||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | Extension Slice: Unordered, Open by value:url | ||
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | required | Valueset for Template Category | 📦1.0.0 | This IG |
| DocumentReference.content:template-message-body.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-body.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-parameters.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.category | Base | required | Valueset for Template Category | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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.
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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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.
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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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 | |||||
| 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 | |||||
| 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.
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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.type | Base | preferred | Document Type Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | required | Valueset for Template Category | 📦1.0.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-body.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-body.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-body.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-body.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-parameters.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-attachment-file.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DocumentReference
Summary
Mandatory: 12 elements(4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | Extension Slice: Unordered, Open by value:url | ||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | Extension Slice: Unordered, Open by value:url | ||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | Extension Slice: Unordered, Open by value:url | ||
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | required | Valueset for Template Category | 📦1.0.0 | This IG |
| DocumentReference.content:template-message-body.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-body.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-parameters.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | |
| Slices for extension |
Content/Rules for all slices | |||
| 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 | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.category | Base | required | Valueset for Template Category | 📦1.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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.
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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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.
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 | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| 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 | Extension Slice: Unordered, Open by value:url | ||||||
| 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 | |||||
| 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 | |||||
| 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.
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 | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | DocumentReferenceStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.docStatus | Base | required | CompositionStatus | 📍4.0.1 | FHIR Std. |
| DocumentReference.type | Base | preferred | Document Type Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.category | Base | required | Valueset for Template Category | 📦1.0.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-body.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-body.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-body.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-body.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-message-parameters.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-message-parameters.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.extension:contentType.value[x] | Base | required | CMS Template Content Type ValueSet | 📦0.4.5 | This IG |
| DocumentReference.content:template-attachment-file.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content:template-attachment-file.format | Base | preferred | DocumentReference Format Code Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v6.5 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from DocumentReference
Summary
Mandatory: 12 elements(4 nested mandatory elements)
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron