Health New Zealand Te Whatu Ora Shared Care FHIR API
0.4.1 - release
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
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Unique identifier |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() |
1..* | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |
![]() ![]() ![]() |
0..1 | Reference(Patient) | Focus of message | |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Message part content | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension | |
![]() ![]() ![]() |
Σ | 0..1 | When scheduled Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Message recipient | |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | |
CommunicationRequest.statusReason | required | CommunicationDeliveryStatusValueSet(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.medium | required | ParticipationModeValueSet(a valid code from ParticipationMode)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset From this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from CommunicationRequest
Path | Conformance | ValueSet | URI |
CommunicationRequest.statusReason | required | CommunicationDeliveryStatusValueSet(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.medium | required | ParticipationModeValueSet(a valid code from ParticipationMode)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() ![]() |
1..* | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Focus of message | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Message part content | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Σ | 0..1 | When scheduled Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Message recipient | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about communication request | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
CommunicationRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | ||||
CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CommunicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.statusReason | required | CommunicationDeliveryStatusValueSet(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.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category From the FHIR Standard | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.medium | required | ParticipationModeValueSet(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.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.payload.content[x]:contentAttachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from 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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |
![]() ![]() ![]() ![]() |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 1..* | Identifier | Unique identifier |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action |
![]() ![]() ![]() |
1..* | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |
![]() ![]() ![]() |
0..1 | Reference(Patient) | Focus of message | |
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Message part content | |
![]() ![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension | |
![]() ![]() ![]() |
Σ | 0..1 | When scheduled Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server |
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Message recipient | |
![]() |
Path | Conformance | ValueSet | URI |
CommunicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | |
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | |
CommunicationRequest.statusReason | required | CommunicationDeliveryStatusValueSet(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.medium | required | ParticipationModeValueSet(a valid code from ParticipationMode)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset From this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from CommunicationRequest
Path | Conformance | ValueSet | URI |
CommunicationRequest.statusReason | required | CommunicationDeliveryStatusValueSet(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.medium | required | ParticipationModeValueSet(a valid code from ParticipationMode)https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | CommunicationRequest | A request for information to be sent to a receiver | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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". | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() |
0..1 | url | Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 1..* | Identifier | Unique identifier | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Resource) | Fulfills plan or proposal | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Composite request this is part of | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request. | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status Binding: Valueset for Communication Delivery Status (required) | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. | |||||
![]() ![]() ![]() |
Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request. | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | True if request is prohibiting action | ||||
![]() ![]() ![]() |
1..* | CodeableConcept | A channel of communication Binding: Valueset for Participation Mode (required) | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Focus of message | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Resources that pertain to this communication request | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
![]() ![]() ![]() |
1..* | BackboneElement | Message payload | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Message part content Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Resource) | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Attachment | Message part content | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Attachment details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | base64Binary | Data inline, base64ed | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() |
Σ | 0..1 | When scheduled Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Must be in UTC timezone on the FHIR server | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | Who/what is requesting service | ||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner) | Message recipient | |||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson | HealthcareService) | Message sender | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Why is communication needed? Binding: v3 Code System ActReason (example): Codes for describing reasons for the occurrence of a communication. | ||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed? | ||||
![]() ![]() ![]() |
0..* | Annotation | Comments made about communication request | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
CommunicationRequest.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
CommunicationRequest.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | ||||
CommunicationRequest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CommunicationRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard | ||||
CommunicationRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.statusReason | required | CommunicationDeliveryStatusValueSet(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.category | example | CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category From the FHIR Standard | ||||
CommunicationRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.medium | required | ParticipationModeValueSet(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.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
CommunicationRequest.payload.content[x]:contentAttachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
CommunicationRequest.reasonCode | example | ActReasonhttp://terminology.hl7.org/ValueSet/v3-ActReason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from 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:
Other representations of profile: CSV, Excel, Schematron