Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release New Zealand flag

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

Resource Profile: CMS Communication Request

Official URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest Version: 0.0.1
Active as of 2025-06-05 Computable Name: CMSCommunicationRequest

This resource is a record of a request for a communication to be performed. The performance of a CommunicationRequest may result in a communication resource. The following content attachment ID's are special message-body attachment-fileX message-template message-parameters

A request for communication

Usages:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... 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: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
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: Valueset for Communication Delivery Status (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 1..* CodeableConcept A channel of communication
Binding: Valueset for Participation Mode (required)
... subject 0..1 Reference(Patient) Focus of message
... payload 1..* BackboneElement Message payload
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment 0..1 Attachment Message part content
...... Slices for extension Content/Rules for all slices
....... extension:Attachment 0..1 (Complex) Attachment details
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
... Slices for occurrence[x] Σ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... authoredOn Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... recipient 0..* Reference(Patient | Practitioner) Message recipient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CommunicationRequest.statusReasonrequiredCommunicationDeliveryStatusValueSet(a valid code from Codes for CommunicationStatus)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
From this IG
CommunicationRequest.mediumrequiredParticipationModeValueSet(a valid code from ParticipationMode)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... meta
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... contained 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... 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:Reply 0..1 (Complex) For sms reply
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
.... use 1..1 code usual | official | temp | secondary | old (If known)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... statusReason 0..1 CodeableConcept Reason for current status
Binding: Valueset for Communication Delivery Status (required)
... medium 1..* CodeableConcept A channel of communication
Binding: Valueset for Participation Mode (required)
... subject 0..1 Reference(Patient) Focus of message
... payload 1..* BackboneElement Message payload
.... Slices for content[x] 1..1 string, Attachment, Reference(Resource) Message part content
Slice: Unordered, Open by type:$this
..... content[x]:contentAttachment 0..1 Attachment Message part content
...... Slices for extension Content/Rules for all slices
....... extension:Attachment 0..1 (Complex) Attachment details
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
... Slices for occurrence[x] 0..1 dateTime, Period When scheduled
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime 0..1 dateTime Must be in UTC timezone on the FHIR server
... authoredOn 0..1 dateTime Must be in UTC timezone on the FHIR server
... recipient 0..* Reference(Patient | Practitioner) Message recipient

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CommunicationRequest.statusReasonrequiredCommunicationDeliveryStatusValueSet(a valid code from Codes for CommunicationStatus)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
From this IG
CommunicationRequest.mediumrequiredParticipationModeValueSet(a valid code from ParticipationMode)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..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.
.... tag Σ 0..* 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... 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: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 Σ 1..* Identifier Unique identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: Valueset for Communication Delivery Status (required)
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 1..* CodeableConcept A channel of communication
Binding: Valueset for Participation Mode (required)
... subject 0..1 Reference(Patient) Focus of message
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... payload 1..* BackboneElement Message payload
.... 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
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment 0..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
....... extension:Attachment 0..1 (Complex) Attachment details
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
...... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
...... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
...... data 0..1 base64Binary Data inline, base64ed
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created
... Slices for occurrence[x] Σ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... authoredOn Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... recipient 0..* Reference(Patient | Practitioner) Message recipient
... sender Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... reasonCode Σ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
CommunicationRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
CommunicationRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CommunicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
CommunicationRequest.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CommunicationRequest.statusReasonrequiredCommunicationDeliveryStatusValueSet(a valid code from Codes for CommunicationStatus)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
From this IG
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
CommunicationRequest.mediumrequiredParticipationModeValueSet(a valid code from ParticipationMode)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
From this IG
CommunicationRequest.payload.content[x]:contentAttachment.contentTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
CommunicationRequest.payload.content[x]:contentAttachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CommunicationRequest

Summary

Mandatory: 8 elements(1 nested mandatory element)
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]
  • The element 1 is sliced based on the value of CommunicationRequest.occurrence[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... 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: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
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: Valueset for Communication Delivery Status (required)
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 1..* CodeableConcept A channel of communication
Binding: Valueset for Participation Mode (required)
... subject 0..1 Reference(Patient) Focus of message
... payload 1..* BackboneElement Message payload
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment 0..1 Attachment Message part content
...... Slices for extension Content/Rules for all slices
....... extension:Attachment 0..1 (Complex) Attachment details
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
... Slices for occurrence[x] Σ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... authoredOn Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... recipient 0..* Reference(Patient | Practitioner) Message recipient

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CommunicationRequest.statusReasonrequiredCommunicationDeliveryStatusValueSet(a valid code from Codes for CommunicationStatus)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
From this IG
CommunicationRequest.mediumrequiredParticipationModeValueSet(a valid code from ParticipationMode)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
From this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... meta
.... profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... contained 0..0
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... 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:Reply 0..1 (Complex) For sms reply
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
.... use 1..1 code usual | official | temp | secondary | old (If known)
.... system 1..1 uri The namespace for the identifier value
.... value 1..1 string The value that is unique
... statusReason 0..1 CodeableConcept Reason for current status
Binding: Valueset for Communication Delivery Status (required)
... medium 1..* CodeableConcept A channel of communication
Binding: Valueset for Participation Mode (required)
... subject 0..1 Reference(Patient) Focus of message
... payload 1..* BackboneElement Message payload
.... Slices for content[x] 1..1 string, Attachment, Reference(Resource) Message part content
Slice: Unordered, Open by type:$this
..... content[x]:contentAttachment 0..1 Attachment Message part content
...... Slices for extension Content/Rules for all slices
....... extension:Attachment 0..1 (Complex) Attachment details
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
... Slices for occurrence[x] 0..1 dateTime, Period When scheduled
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrenceDateTime 0..1 dateTime Must be in UTC timezone on the FHIR server
... authoredOn 0..1 dateTime Must be in UTC timezone on the FHIR server
... recipient 0..* Reference(Patient | Practitioner) Message recipient

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
CommunicationRequest.statusReasonrequiredCommunicationDeliveryStatusValueSet(a valid code from Codes for CommunicationStatus)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
From this IG
CommunicationRequest.mediumrequiredParticipationModeValueSet(a valid code from ParticipationMode)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..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.
.... tag Σ 0..* 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".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... 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: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 Σ 1..* Identifier Unique identifier
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 1..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... basedOn Σ 0..* Reference(Resource) Fulfills plan or proposal
... replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
... groupIdentifier Σ 0..1 Identifier Composite request this is part of
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of the communication request.
... statusReason 0..1 CodeableConcept Reason for current status
Binding: Valueset for Communication Delivery Status (required)
... category 0..* CodeableConcept Message category
Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
... doNotPerform ?!Σ 0..1 boolean True if request is prohibiting action
... medium 1..* CodeableConcept A channel of communication
Binding: Valueset for Participation Mode (required)
... subject 0..1 Reference(Patient) Focus of message
... about 0..* Reference(Resource) Resources that pertain to this communication request
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... payload 1..* BackboneElement Message payload
.... 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
.... Slices for content[x] 1..1 Message part content
Slice: Unordered, Open by type:$this
..... contentString string
..... contentAttachment Attachment
..... contentReference Reference(Resource)
..... content[x]:contentAttachment 0..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
....... extension:Attachment 0..1 (Complex) Attachment details
URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
...... contentType Σ 0..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
Example General: text/plain; charset=UTF-8, image/png
...... language Σ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding

Example General: en-AU
...... data 0..1 base64Binary Data inline, base64ed
...... url Σ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ 0..1 unsignedInt Number of bytes of content (if url provided)
...... hash Σ 0..1 base64Binary Hash of the data (sha-1, base64ed)
...... title Σ 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
...... creation Σ 0..1 dateTime Date attachment was first created
... Slices for occurrence[x] Σ 0..1 When scheduled
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrence[x]:occurrenceDateTime Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... authoredOn Σ 0..1 dateTime Must be in UTC timezone on the FHIR server
... requester Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who/what is requesting service
... recipient 0..* Reference(Patient | Practitioner) Message recipient
... sender Σ 0..1 Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) Message sender
... reasonCode Σ 0..* CodeableConcept Why is communication needed?
Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication.
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why is communication needed?
... note 0..* Annotation Comments made about communication request

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CommunicationRequest.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
From the FHIR Standard
CommunicationRequest.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
From the FHIR Standard
CommunicationRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CommunicationRequest.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
CommunicationRequest.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
From the FHIR Standard
CommunicationRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CommunicationRequest.statusReasonrequiredCommunicationDeliveryStatusValueSet(a valid code from Codes for CommunicationStatus)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
From this IG
CommunicationRequest.categoryexampleCommunicationCategory
http://hl7.org/fhir/ValueSet/communication-category
From the FHIR Standard
CommunicationRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
From the FHIR Standard
CommunicationRequest.mediumrequiredParticipationModeValueSet(a valid code from ParticipationMode)
https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
From this IG
CommunicationRequest.payload.content[x]:contentAttachment.contentTyperequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
CommunicationRequest.payload.content[x]:contentAttachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CommunicationRequest.reasonCodeexampleActReason
http://terminology.hl7.org/ValueSet/v3-ActReason

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCommunicationRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCommunicationRequestIf 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-4errorCommunicationRequestIf 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-5errorCommunicationRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCommunicationRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CommunicationRequest

Summary

Mandatory: 8 elements(1 nested mandatory element)
Prohibited: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CommunicationRequest.payload.content[x]
  • The element 1 is sliced based on the value of CommunicationRequest.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron