openIMIS FHIR R4 Implementation Guide
1.0.0 - ci-build

openIMIS FHIR R4 Implementation Guide - Local Development build (v1.0.0). See the Directory of published versions

Resource Profile: openIMIS CommunicationRequest

Official URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/openimis-communication-request Version: 1.0.0
Active as of 2022-05-31 Responsible: openIMIS Initiative Computable Name: OpenIMISCommunicationRequest

Defines a CommunicationRequest for openIMIS which maps to the Claim request for feedback in openIMIS.

Usage:

Formal Views of Profile Content

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

This structure is derived from CommunicationRequest

Summary

Mandatory: 21 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element CommunicationRequest.payload is sliced based on the value of value:extension[type].valueCodeableConcept.coding.code (Closed)

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... identifier 0..0
... basedOn 0..0
... replaces 0..0
... status 1..1codeactive | completed | revoked
Binding: Claim Feedback Status (CommunicationRequest) (required)
... statusReason 1..1CodeableConceptReason for current status
Binding: Feedback Status (CommunicationRequest) (required)
... category 0..0
... priority 0..0
... doNotPerform 0..0
... medium 0..0
... subject 1..1Reference(openIMIS Patient)Focus of message
... about 1..1Reference(openIMIS Claim)Resources that pertain to this communication request
... encounter 0..0
... Slices for payload 5..5BackboneElementMessage payload
Slice: Unordered, Closed by value:extension[type].valueCodeableConcept.coding.code
.... payload:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
..... content[x] 1..1stringMessage part content
.... payload:CareRendered 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: CareRendered
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Care Rendered? (yes|no)
.... payload:PaymentAsked 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: PaymentAsked
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Payment Asked? (yes|no)
.... payload:DrugPrescribed 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugPrescribed
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Drug Prescribed? (yes|no)
.... payload:DrugReceived 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugReceived
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Drug Received? (yes|no)
.... payload:Asessment 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: Asessment
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Asessment? (0|1|2|3|4|5)
... occurrence[x] 0..0
... authoredOn 0..0
... requester 0..0
... recipient 1..1Reference(openIMIS Enrolment Officer Practitioner)Enrolment Officer
... sender 0..0
... reasonCode 0..0
... reasonReference 0..0
... note 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | completed | revoked
Binding: Claim Feedback Status (CommunicationRequest) (required)
... statusReason 1..1CodeableConceptReason for current status
Binding: Feedback Status (CommunicationRequest) (required)
... subject 1..1Reference(openIMIS Patient)Focus of message
... about 1..1Reference(openIMIS Claim)Resources that pertain to this communication request
... Slices for payload 5..5BackboneElementMessage payload
Slice: Unordered, Closed by value:extension[type].valueCodeableConcept.coding.code
.... payload:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1stringMessage part content
.... payload:CareRendered 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: CareRendered
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Care Rendered? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:PaymentAsked 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PaymentAsked
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Payment Asked? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:DrugPrescribed 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugPrescribed
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Drug Prescribed? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:DrugReceived 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugReceived
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Drug Received? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:Asessment 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: Asessment
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Asessment? (0|1|2|3|4|5)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
... recipient 1..1Reference(openIMIS Enrolment Officer Practitioner)Enrolment Officer

doco Documentation for this format

This structure is derived from CommunicationRequest

Summary

Mandatory: 21 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element CommunicationRequest.payload is sliced based on the value of value:extension[type].valueCodeableConcept.coding.code (Closed)

Differential View

This structure is derived from CommunicationRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... identifier 0..0
... basedOn 0..0
... replaces 0..0
... status 1..1codeactive | completed | revoked
Binding: Claim Feedback Status (CommunicationRequest) (required)
... statusReason 1..1CodeableConceptReason for current status
Binding: Feedback Status (CommunicationRequest) (required)
... category 0..0
... priority 0..0
... doNotPerform 0..0
... medium 0..0
... subject 1..1Reference(openIMIS Patient)Focus of message
... about 1..1Reference(openIMIS Claim)Resources that pertain to this communication request
... encounter 0..0
... Slices for payload 5..5BackboneElementMessage payload
Slice: Unordered, Closed by value:extension[type].valueCodeableConcept.coding.code
.... payload:All Slices Content/Rules for all slices
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
..... content[x] 1..1stringMessage part content
.... payload:CareRendered 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: CareRendered
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Care Rendered? (yes|no)
.... payload:PaymentAsked 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: PaymentAsked
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Payment Asked? (yes|no)
.... payload:DrugPrescribed 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugPrescribed
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Drug Prescribed? (yes|no)
.... payload:DrugReceived 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugReceived
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Drug Received? (yes|no)
.... payload:Asessment 1..1BackboneElementMessage payload
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... valueCodeableConcept 0..1CodeableConceptValue of extension
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: Asessment
..... contentString 1..1string, Attachment, Reference(Resource)Message part content
Required Pattern: Asessment? (0|1|2|3|4|5)
... occurrence[x] 0..0
... authoredOn 0..0
... requester 0..0
... recipient 1..1Reference(openIMIS Enrolment Officer Practitioner)Enrolment Officer
... sender 0..0
... reasonCode 0..0
... reasonReference 0..0
... note 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CommunicationRequest 0..*CommunicationRequestA request for information to be sent to a receiver
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!Σ1..1codeactive | completed | revoked
Binding: Claim Feedback Status (CommunicationRequest) (required)
... statusReason 1..1CodeableConceptReason for current status
Binding: Feedback Status (CommunicationRequest) (required)
... subject 1..1Reference(openIMIS Patient)Focus of message
... about 1..1Reference(openIMIS Claim)Resources that pertain to this communication request
... Slices for payload 5..5BackboneElementMessage payload
Slice: Unordered, Closed by value:extension[type].valueCodeableConcept.coding.code
.... payload:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1stringMessage part content
.... payload:CareRendered 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: CareRendered
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Care Rendered? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:PaymentAsked 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: PaymentAsked
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Payment Asked? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:DrugPrescribed 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugPrescribed
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Drug Prescribed? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:DrugReceived 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: DrugReceived
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Drug Received? (yes|no)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
.... payload:Asessment 1..1BackboneElementMessage payload
..... id 0..1stringUnique id for inter-element referencing
..... communication-payload-type 1..1CodeableConceptPayload Type (CommunicationRequest | Communication)
URL: https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..0
...... url 1..1uri"https://openimis.github.io/openimis_fhir_r4_ig/StructureDefinition/communication-payload-type"
...... Slices for value[x] 0..1CodeableConceptValue of extension
Slice: Unordered, Closed by type:$this
....... value[x]:valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: Feedback Payload (CommunicationRequest | Communication) (required)
Required Pattern: At least the following
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
......... id0..1stringUnique id for inter-element referencing
......... extension0..*ExtensionAdditional content defined by implementations
......... system1..1uriIdentity of the terminology system
Fixed Value: https://openimis.github.io/openimis_fhir_r4_ig/CodeSystem/feedback-payload
......... version0..1stringVersion of the system - if relevant
......... code1..1codeSymbol in syntax defined by the system
Fixed Value: Asessment
......... display0..1stringRepresentation defined by the system
......... userSelected0..1booleanIf this coding was chosen directly by the user
........ text0..1stringPlain text representation of the concept
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... content[x] 1..1Message part content
Required Pattern: Asessment? (0|1|2|3|4|5)
...... contentStringstring
...... contentAttachmentAttachment
...... contentReferenceReference(Resource)
... recipient 1..1Reference(openIMIS Enrolment Officer Practitioner)Enrolment Officer

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
CommunicationRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
CommunicationRequest.statusrequiredCommunicationRequestStatusVS
CommunicationRequest.statusReasonrequiredFeedbackStatusVS
CommunicationRequest.payload:CareRendered.extension:type.value[x]:valueCodeableConceptrequiredPattern: CareRendered
CommunicationRequest.payload:PaymentAsked.extension:type.value[x]:valueCodeableConceptrequiredPattern: PaymentAsked
CommunicationRequest.payload:DrugPrescribed.extension:type.value[x]:valueCodeableConceptrequiredPattern: DrugPrescribed
CommunicationRequest.payload:DrugReceived.extension:type.value[x]:valueCodeableConceptrequiredPattern: DrugReceived
CommunicationRequest.payload:Asessment.extension:type.value[x]:valueCodeableConceptrequiredPattern: Asessment

Constraints

IdGradePathDetailsRequirements
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-1errorCommunicationRequest.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.aboutAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payloadAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:CareRenderedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:CareRendered.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:CareRendered.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:CareRendered.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:CareRendered.extension:type.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:CareRendered.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:CareRendered.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:CareRendered.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:PaymentAskedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:PaymentAsked.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:PaymentAsked.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:PaymentAsked.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:PaymentAsked.extension:type.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:PaymentAsked.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:PaymentAsked.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:PaymentAsked.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugPrescribedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugPrescribed.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:DrugPrescribed.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:DrugPrescribed.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugPrescribed.extension:type.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugPrescribed.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:DrugPrescribed.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:DrugPrescribed.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugReceivedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugReceived.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:DrugReceived.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:DrugReceived.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugReceived.extension:type.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:DrugReceived.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:DrugReceived.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:DrugReceived.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:AsessmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:Asessment.extension:typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:Asessment.extension:typeMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:Asessment.extension:type.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:Asessment.extension:type.value[x]:valueCodeableConceptAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.payload:Asessment.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorCommunicationRequest.payload:Asessment.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorCommunicationRequest.payload:Asessment.content[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorCommunicationRequest.recipientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())