Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.7 - release
Health New Zealand Te Whatu Ora Shared Care FHIR API - Local Development build (v0.4.7) 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/CMSCommunication | Version: 1.0.1 | |||
| Active as of 2026-10-13 | Computable Name: CMSCommunication | |||
A communication Resource used to record the SMS/EMAIL communication performed by Systems
Record all the SMS/EMAIL communication performed by any system
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:  |
|---|---|---|---|---|
  Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
  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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   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 | |
 Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 extension:Campaign |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |
| extension:ContactPoint |
1..1 | (Complex) | Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension | |
| extension:CallbackUrl |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |
| extension:StatusDateTime |
1..1 | dateTime | Status DateTime URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension | |
 extension:Reply |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 basedOn |
0..1 | Reference(Resource) | Request fulfilled by this communication | |
| inResponseTo |
0..1 | Reference(Communication) | Reply to | |
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | |
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |
| category |
0..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |
| medium |
1..1 | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |
| subject |
0..1 | Reference(Patient) | Focus of message | |
| sent |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| recipient |
0..* | Reference(Patient | Practitioner) | Message recipient | |
| Slices for payload |
0..* | BackboneElement | Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
  payload:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 content[x] |
1..1 | Message part content | ||
| contentString |
string | |||
| contentAttachment |
Attachment | |||
 contentReference |
Reference(Resource) | |||
| payload:message-body |
0..1 | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 Slices for extension |
Content/Rules for all slices | |||
 extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
 Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| 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/plain | |
| payload:attachment-file |
0..* | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| 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 |
| Communication.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | required | Valueset for Communication Delivery Status | 📦1.0.0 | This IG |
| Communication.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | required | Valueset for Participation Mode | 📦1.0.0 | This IG |
| Communication.payload:message-body.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Communication.payload:message-body.content[x]:contentAttachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment-file.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 | |
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:Campaign |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |
| extension:ContactPoint |
1..1 | (Complex) | Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension | |
| extension:CallbackUrl |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |
| extension:StatusDateTime |
1..1 | dateTime | Status DateTime URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension | |
| extension:Reply |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |
| basedOn |
0..1 | Reference(Resource) | Request fulfilled by this communication | |
| inResponseTo |
0..1 | Reference(Communication) | Reply to | |
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |
| category |
0..1 | CodeableConcept | Message category | |
| medium |
1..1 | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |
| subject |
0..1 | Reference(Patient) | Focus of message | |
| sent |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| recipient |
0..* | Reference(Patient | Practitioner) | Message recipient | |
| Slices for payload |
0..* | BackboneElement | Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| payload:message-body |
0..1 | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension | |
| value[x] |
0..1 | code | Value of extension Required Pattern: body | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| contentType |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: text/plain | |
| payload:attachment-file |
0..* | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension | |
| value[x] |
0..1 | code | Value of extension Required Pattern: attachment | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| 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 |
| Communication.statusReason | Base | required | Valueset for Communication Delivery Status | 📦1.0.0 | This IG |
| Communication.medium | Base | required | Valueset for Participation Mode | 📦1.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
| 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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:Campaign |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |||||
| extension:ContactPoint |
1..1 | (Complex) | Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension | |||||
| extension:CallbackUrl |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |||||
| extension:StatusDateTime |
1..1 | dateTime | Status DateTime URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension | |||||
| extension:Reply |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Unique identifier | |||||
| instantiatesCanonical |
0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..1 | Reference(Resource) | Request fulfilled by this communication | |||||
| partOf |
0..* | Reference(Resource) | Part of this action | |||||
| inResponseTo |
0..1 | Reference(Communication) | Reply to | |||||
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | |||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |||||
| category |
0..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | |||||
| medium |
1..1 | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |||||
| subject |
0..1 | Reference(Patient) | Focus of message | |||||
| topic |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
| about |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
| sent |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |||||
| received |
0..1 | dateTime | When received | |||||
| recipient |
0..* | Reference(Patient | Practitioner) | Message recipient | |||||
| sender |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| reasonCode |
0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | |||||
| Slices for payload |
0..* | BackboneElement | Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| payload: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 | |||||
| content[x] |
1..1 | Message part content | ||||||
| contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| payload:message-body |
0..1 | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |||||
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for content[x] |
Content/Rules for all slices | |||||||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |||||
| 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/plain | |||||
| 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 | |||||
| payload:attachment-file |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |||||
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for content[x] |
Content/Rules for all slices | |||||||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |||||
| 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 | |||||
| note |
0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Communication.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | required | Valueset for Communication Delivery Status | 📦1.0.0 | This IG |
| Communication.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| Communication.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | required | Valueset for Participation Mode | 📦1.0.0 | This IG |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Communication.payload:message-body.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Communication.payload:message-body.content[x]:contentAttachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Communication.payload:message-body.content[x]:contentAttachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment-file.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Communication.payload:attachment-file.content[x]:contentAttachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment-file.content[x]:contentAttachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Communication
Summary
Mandatory: 9 elements(6 nested mandatory elements)
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
| 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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 | |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:Campaign |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |
| extension:ContactPoint |
1..1 | (Complex) | Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension | |
| extension:CallbackUrl |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |
| extension:StatusDateTime |
1..1 | dateTime | Status DateTime URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension | |
| extension:Reply |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| basedOn |
0..1 | Reference(Resource) | Request fulfilled by this communication | |
| inResponseTo |
0..1 | Reference(Communication) | Reply to | |
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | |
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |
| category |
0..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |
| medium |
1..1 | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |
| subject |
0..1 | Reference(Patient) | Focus of message | |
| sent |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| recipient |
0..* | Reference(Patient | Practitioner) | Message recipient | |
| Slices for payload |
0..* | BackboneElement | Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| payload:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| content[x] |
1..1 | Message part content | ||
| contentString |
string | |||
| contentAttachment |
Attachment | |||
| contentReference |
Reference(Resource) | |||
| payload:message-body |
0..1 | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| 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/plain | |
| payload:attachment-file |
0..* | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| 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 |
| Communication.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | required | Valueset for Communication Delivery Status | 📦1.0.0 | This IG |
| Communication.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | required | Valueset for Participation Mode | 📦1.0.0 | This IG |
| Communication.payload:message-body.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Communication.payload:message-body.content[x]:contentAttachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment-file.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from Communication
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| 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 | |
| contained |
0..0 | Contained, inline Resources | ||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:Campaign |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |
| extension:ContactPoint |
1..1 | (Complex) | Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension | |
| extension:CallbackUrl |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |
| extension:StatusDateTime |
1..1 | dateTime | Status DateTime URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension | |
| extension:Reply |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |
| basedOn |
0..1 | Reference(Resource) | Request fulfilled by this communication | |
| inResponseTo |
0..1 | Reference(Communication) | Reply to | |
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |
| category |
0..1 | CodeableConcept | Message category | |
| medium |
1..1 | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |
| subject |
0..1 | Reference(Patient) | Focus of message | |
| sent |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |
| recipient |
0..* | Reference(Patient | Practitioner) | Message recipient | |
| Slices for payload |
0..* | BackboneElement | Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| payload:message-body |
0..1 | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension | |
| value[x] |
0..1 | code | Value of extension Required Pattern: body | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| contentType |
0..1 | code | Mime type of the content, with charset etc. Required Pattern: text/plain | |
| payload:attachment-file |
0..* | BackboneElement | Message payload | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension | |
| value[x] |
0..1 | code | Value of extension Required Pattern: attachment | |
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Open by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| Slices for content[x] |
Content/Rules for all slices | |||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |
| 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 |
| Communication.statusReason | Base | required | Valueset for Communication Delivery Status | 📦1.0.0 | This IG |
| Communication.medium | Base | required | Valueset for Participation Mode | 📦1.0.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Communication |
0..* | Communication | A record of information transmitted from a sender to a receiver | |||||
| 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". Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| 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 | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:Campaign |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |||||
| extension:ContactPoint |
1..1 | (Complex) | Send to and from communication to contact points URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension | |||||
| extension:CallbackUrl |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |||||
| extension:StatusDateTime |
1..1 | dateTime | Status DateTime URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-status-date-time-extension | |||||
| extension:Reply |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..* | Identifier | Unique identifier | |||||
| instantiatesCanonical |
0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri |
0..* | uri | Instantiates external protocol or definition | |||||
| basedOn |
0..1 | Reference(Resource) | Request fulfilled by this communication | |||||
| partOf |
0..* | Reference(Resource) | Part of this action | |||||
| inResponseTo |
0..1 | Reference(Communication) | Reply to | |||||
| status |
1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required): The status of the communication. | |||||
| statusReason |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |||||
| category |
0..1 | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instructions, etc. | |||||
| priority |
0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication. | |||||
| medium |
1..1 | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |||||
| subject |
0..1 | Reference(Patient) | Focus of message | |||||
| topic |
0..1 | CodeableConcept | Description of the purpose/content Binding: CommunicationTopic (example): Codes describing the purpose or content of the communication. | |||||
| about |
0..* | Reference(Resource) | Resources that pertain to this communication | |||||
| encounter |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
| sent |
0..1 | dateTime | Must be in UTC timezone on the FHIR server | |||||
| received |
0..1 | dateTime | When received | |||||
| recipient |
0..* | Reference(Patient | Practitioner) | Message recipient | |||||
| sender |
0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | |||||
| reasonCode |
0..* | CodeableConcept | Indication for message Binding: SNOMEDCTClinicalFindings (example): Codes for describing reasons for the occurrence of a communication. | |||||
| reasonReference |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why was communication done? | |||||
| Slices for payload |
0..* | BackboneElement | Message payload Slice: Unordered, Open by value:extension('https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-type-extension').value Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| payload: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 | |||||
| content[x] |
1..1 | Message part content | ||||||
| contentString |
string | |||||||
| contentAttachment |
Attachment | |||||||
| contentReference |
Reference(Resource) | |||||||
| payload:message-body |
0..1 | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |||||
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: body | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for content[x] |
Content/Rules for all slices | |||||||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |||||
| 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/plain | |||||
| 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 | |||||
| payload:attachment-file |
0..* | BackboneElement | Message payload | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for extension |
Content/Rules for all slices | |||||||
| extension:payloadType |
1..1 | (Complex) | CMS Payload Type Extension URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/cms-payload-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-payload-type-extension" | |||||
| value[x] |
0..1 | code | Value of extension Binding: CMS Payload Type ValueSet (required) Required Pattern: attachment | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| Slices for content[x] |
1..1 | Attachment | Message part content Slice: Unordered, Closed by type:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| Slices for content[x] |
Content/Rules for all slices | |||||||
| content[x]:contentAttachment |
1..1 | Attachment | Message part content | |||||
| 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 | |||||
| note |
0..* | Annotation | Comments made about the communication | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Communication.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| Communication.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.meta.tag:correlationId | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| Communication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.status | Base | required | EventStatus | 📍4.0.1 | FHIR Std. |
| Communication.statusReason | Base | required | Valueset for Communication Delivery Status | 📦1.0.0 | This IG |
| Communication.category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std. |
| Communication.priority | Base | required | Request priority | 📍4.0.1 | FHIR Std. |
| Communication.medium | Base | required | Valueset for Participation Mode | 📦1.0.0 | This IG |
| Communication.topic | Base | example | CommunicationTopic | 📍4.0.1 | FHIR Std. |
| Communication.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| Communication.payload:message-body.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Communication.payload:message-body.content[x]:contentAttachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Communication.payload:message-body.content[x]:contentAttachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment-file.extension:payloadType.value[x] | Base | required | CMS Payload Type ValueSet | 📦0.4.7 | This IG |
| Communication.payload:attachment-file.content[x]:contentAttachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| Communication.payload:attachment-file.content[x]:contentAttachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Communication
Summary
Mandatory: 9 elements(6 nested mandatory elements)
Prohibited: 1 element
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron