CMSCommunicationRequest
type: StructureDefinition
node role: treeRoot
id:
  v: CMSCommunicationRequest
text:
  status:
    v: extensions
  div: Generated Narrative: StructureDefinition CMSCommunicationRequest Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> CommunicationRequest 0..* CommunicationRequest A request for information to be sent to a receiver #xD; meta #xD; profile 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to #xD; contained 0..0 #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:Campaign 0..1 (Complex) Campaign details URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension #xD; 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 #xD; extension:CallbackUrl 0..1 url Callback Url URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension #xD; extension:Reply 0..1 (Complex) For sms reply URL: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension #xD; identifier 1..* Identifier Unique identifier #xD; use 1..1 code usual | official | temp | secondary | old (If known) #xD; system 1..1 uri The namespace for the identifier value #xD; value 1..1 string The value that is unique #xD; statusReason 0..1 CodeableConcept Reason for current status Binding: Valueset for Communication Delivery Status (required) #xD; medium 1..* CodeableConcept A channel of communication Binding: Valueset for Participation Mode (required) #xD; subject 0..1 Reference(Patient) Focus of message #xD; payload 1..* BackboneElement Message payload #xD; Slices for content[x] 1..1 string, Attachment, Reference(Resource) Message part content Slice: Unordered, Open by type:$this #xD; content[x]:contentAttachment 0..1 Attachment Message part content #xD; Slices for extension Content/Rules for all slices #xD; extension:Attachment 0..1 (Complex)…
url:
  v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/CMSCommunicationRequest
version:
  v: 0.0.1
name:
  v: CMSCommunicationRequest
title:
  v: CMS Communication Request
status:
  v: active
date:
  v: 2025-12-11T23:52:07+00:00
publisher:
  v: Te Whatu Ora
contact:
  name:
    v: Te Whatu Ora
  telecom:
    system:
      v: url
    value:
      v: https://www.tewhatuora.govt.nz/
contact:
  name:
    v: Te Whatu Ora Integration Team
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: 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
jurisdiction:
  coding:
    system:
      v: urn:iso:std:iso:3166
    code:
      v: NZ
    display:
      v: New Zealand
purpose:
  v: A request for communication
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: workflow
  uri:
    v: http://hl7.org/fhir/workflow
  name:
    v: Workflow Pattern
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: CommunicationRequest
base definition:
  v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
  link: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
derivation:
  v: constraint
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
    value: string
      v: 4.0.1
  element:
    id:
      v: CommunicationRequest
    path:
      v: CommunicationRequest
    short:
      v: A request for information to be sent to a receiver
    definition:
      v: A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: CommunicationRequest
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: 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
      expression:
        v: 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()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      extension:
        value: boolean
      extension:
        value: markdown
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: Entity. Role, or Act
    mapping:
      identity:
        v: workflow
      map:
        v: Request
  element:
    id:
      v: CommunicationRequest.id
    path:
      v: CommunicationRequest.id

boolean
v: true

markdown
v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: Logical id of this artifact

v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

v: 0

v: 1

path:
  v: Resource.id
min:
  v: 0
max:
  v: 1

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
  value: url
    v: id
code:
  v: http://hl7.org/fhirpath/System.String

v: false

v: true

id:
  v: CommunicationRequest.meta
path:
  v: CommunicationRequest.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: CommunicationRequest.meta.id
path:
  v: CommunicationRequest.meta.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.meta.extension
path:
  v: CommunicationRequest.meta.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.meta.versionId
path:
  v: CommunicationRequest.meta.versionId
short:
  v: Version specific identifier
definition:
  v: The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
comment:
  v: The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Meta.versionId
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: id
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: CommunicationRequest.meta.lastUpdated
path:
  v: CommunicationRequest.meta.lastUpdated
short:
  v: When the resource version last changed
definition:
  v: When the resource last changed - e.g. when the version changed.
comment:
  v: This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a [read](http://hl7.org/fhir/R4/http.html#read) interaction.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Meta.lastUpdated
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: CommunicationRequest.meta.source
path:
  v: CommunicationRequest.meta.source
short:
  v: Identifies where the resource comes from
definition:
  v: A uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](http://hl7.org/fhir/R4/provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
comment:
  v: In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Meta.source
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: CommunicationRequest.meta.profile
path:
  v: CommunicationRequest.meta.profile
short:
  v: Profiles this resource claims to conform to
definition:
  v: A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/R4/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/R4/structuredefinition-definitions.html#StructureDefinition.url).
comment:
  v: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Meta.profile
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: canonical
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/StructureDefinition
    link: http://hl7.org/fhir/StructureDefinition/StructureDefinition
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: CommunicationRequest.meta.security
path:
  v: CommunicationRequest.meta.security
short:
  v: Security Labels applied to this resource
definition:
  v: Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
comment:
  v: The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Meta.security
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: SecurityLabels
  strength:
    v: extensible
  description:
    v: Security Labels from the Healthcare Privacy and Security Classification System.
  value set:
    v: http://hl7.org/fhir/ValueSet/security-labels
    link: http://hl7.org/fhir/ValueSet/security-labels

id:
  v: CommunicationRequest.meta.tag
path:
  v: CommunicationRequest.meta.tag
short:
  v: Tags applied to this resource
definition:
  v: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
comment:
  v: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Meta.tag
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: Tags
  strength:
    v: example
  description:
    v: Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
  value set:
    v: http://hl7.org/fhir/ValueSet/common-tags
    link: http://hl7.org/fhir/ValueSet/common-tags

id:
  v: CommunicationRequest.implicitRules
path:
  v: CommunicationRequest.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
is summary:
  v: true

id:
  v: CommunicationRequest.language
path:
  v: CommunicationRequest.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value: canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages

id:
  v: CommunicationRequest.text
path:
  v: CommunicationRequest.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: CommunicationRequest.contained
path:
  v: CommunicationRequest.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: 0
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.extension
path:
  v: CommunicationRequest.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 1
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.extension:Campaign
path:
  v: CommunicationRequest.extension
slice name:
  v: Campaign
short:
  v: Campaign details
definition:
  v: For storing campaign codes and names
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
    link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.extension:ContactPoint
path:
  v: CommunicationRequest.extension
slice name:
  v: ContactPoint
short:
  v: Send to and from communication to contact points
definition:
  v: Communication send to and from contact point
min:
  v: 1
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
    link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.extension:CallbackUrl
path:
  v: CommunicationRequest.extension
slice name:
  v: CallbackUrl
short:
  v: Callback Url
definition:
  v: Callback Url for system
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
    link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.extension:Reply
path:
  v: CommunicationRequest.extension
slice name:
  v: Reply
short:
  v: For sms reply
definition:
  v: Specifies whether a reply is expected and provides a webhook URL for the reply.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
    link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
condition:
  v: ele-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.modifierExtension
path:
  v: CommunicationRequest.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.identifier
path:
  v: CommunicationRequest.identifier
short:
  v: Unique identifier
definition:
  v: Business identifiers assigned to this communication request by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
comment:
  v: This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.
requirements:
  v: Allows identification of the communication request as it is known by various participating systems and in a way that remains consistent across servers.
min:
  v: 1
max:
  v: *
base:
  path:
    v: CommunicationRequest.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.identifier
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier

id:
  v: CommunicationRequest.identifier.id
path:
  v: CommunicationRequest.identifier.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.identifier.extension
path:
  v: CommunicationRequest.identifier.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.identifier.use
path:
  v: CommunicationRequest.identifier.use
short:
  v: usual | official | temp | secondary | old (If known)
definition:
  v: The purpose of this identifier.
comment:
  v: Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
requirements:
  v: Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.use
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: IdentifierUse
  strength:
    v: required
  description:
    v: Identifies the purpose for this identifier, if known .
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: N/A
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: CommunicationRequest.identifier.type
path:
  v: CommunicationRequest.identifier.type
short:
  v: Description of identifier
definition:
  v: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
comment:
  v: This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
requirements:
  v: Allows users to make use of identifiers when the identifier system is not known.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: IdentifierType
  strength:
    v: extensible
  description:
    v: A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
  value set:
    v: http://hl7.org/fhir/ValueSet/identifier-type
    link: http://hl7.org/fhir/ValueSet/identifier-type
mapping:
  identity:
    v: v2
  map:
    v: CX.5
mapping:
  identity:
    v: rim
  map:
    v: Role.code or implied by context

id:
  v: CommunicationRequest.identifier.system
path:
  v: CommunicationRequest.identifier.system
short:
  v: The namespace for the identifier value
definition:
  v: Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
comment:
  v: Identifier.system is always case sensitive.
requirements:
  v: There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.system
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
example:
  label:
    v: General
  value: uri
    v: http://www.acme.com/identifiers/patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / EI-2-4
mapping:
  identity:
    v: rim
  map:
    v: II.root or Role.id.root
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierType

id:
  v: CommunicationRequest.identifier.value
path:
  v: CommunicationRequest.identifier.value
short:
  v: The value that is unique
definition:
  v: The portion of the identifier typically relevant to the user and which is unique within the context of the system.
comment:
  v: If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Identifier.value
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: 123456
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.1 / EI.1
mapping:
  identity:
    v: rim
  map:
    v: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
mapping:
  identity:
    v: servd
  map:
    v: ./Value

id:
  v: CommunicationRequest.identifier.period
path:
  v: CommunicationRequest.identifier.period
short:
  v: Time period when id is/was valid for use
definition:
  v: Time period during which identifier is/was valid for use.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.period
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.7 + CX.8
mapping:
  identity:
    v: rim
  map:
    v: Role.effectiveTime or implied by context
mapping:
  identity:
    v: servd
  map:
    v: ./StartDate and ./EndDate

id:
  v: CommunicationRequest.identifier.assigner
path:
  v: CommunicationRequest.identifier.assigner
short:
  v: Organization that issued id (may be just text)
definition:
  v: Organization that issued/manages the identifier.
comment:
  v: The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Identifier.assigner
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: CX.4 / (CX.4,CX.9,CX.10)
mapping:
  identity:
    v: rim
  map:
    v: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
mapping:
  identity:
    v: servd
  map:
    v: ./IdentifierIssuingAuthority

id:
  v: CommunicationRequest.basedOn
path:
  v: CommunicationRequest.basedOn
short:
  v: Fulfills plan or proposal
definition:
  v: A plan or proposal that is fulfilled in whole or in part by this request.
requirements:
  v: Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.
alias:
  v: fulfills
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.basedOn
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    link: http://hl7.org/fhir/StructureDefinition/Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.basedOn
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=FLFS].target

id:
  v: CommunicationRequest.replaces
path:
  v: CommunicationRequest.replaces
short:
  v: Request(s) replaced by this request
definition:
  v: Completed or terminated request(s) whose function is taken by this new request.
comment:
  v: The replacement could be because the initial request was immediately rejected (due to an issue) or because the previous request was completed, but the need for the action described by the request remains ongoing.
requirements:
  v: Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.
alias:
  v: supersedes
alias:
  v: prior
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.replaces
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
    link: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.replaces
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RPLC].target

id:
  v: CommunicationRequest.groupIdentifier
path:
  v: CommunicationRequest.groupIdentifier
short:
  v: Composite request this is part of
definition:
  v: A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition, prescription or similar form.
comment:
  v: Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.
alias:
  v: grouperId
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.groupIdentifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.groupIdentifier
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship(typeCode=COMP].source[moodCode=INT].identifier

id:
  v: CommunicationRequest.status
path:
  v: CommunicationRequest.status
short:
  v: draft | active | on-hold | revoked | completed | entered-in-error | unknown
definition:
  v: The status of the proposal or order.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CommunicationRequest.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid.
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: CommunicationRequestStatus
  strength:
    v: required
  description:
    v: The status of the communication request.
  value set:
    v: http://hl7.org/fhir/ValueSet/request-status|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: workflow
  map:
    v: Request.status
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status

id:
  v: CommunicationRequest.statusReason
path:
  v: CommunicationRequest.statusReason
short:
  v: Reason for current status
definition:
  v: Captures the reason for the current state of the CommunicationRequest.
comment:
  v: This is generally only used for "exception" statuses such as "suspended" or "cancelled". The reason why the CommunicationRequest was created at all is captured in reasonCode, not here. [distinct reason codes for different statuses can be enforced using invariants if they are universal bindings].
alias:
  v: Suspended Reason
alias:
  v: Cancelled Reason
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.statusReason
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: required
  value set:
    v: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
    link: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
mapping:
  identity:
    v: workflow
  map:
    v: Request.statusReason
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship[typeCode=SUBJ].source[classCode=CACT, moodCode=EVN].reasonCOde

id:
  v: CommunicationRequest.category
path:
  v: CommunicationRequest.category
short:
  v: Message category
definition:
  v: The type of message to be sent such as alert, notification, reminder, instruction, etc.
comment:
  v: There may be multiple axes of categorization and one communication request may serve multiple purposes.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.category
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: CommunicationCategory
  strength:
    v: example
  description:
    v: Codes for general categories of communications such as alerts, instruction, etc.
  value set:
    v: http://hl7.org/fhir/ValueSet/communication-category
    link: http://hl7.org/fhir/ValueSet/communication-category
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class

id:
  v: CommunicationRequest.priority
path:
  v: CommunicationRequest.priority
short:
  v: routine | urgent | asap | stat
definition:
  v: Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.priority
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
meaning when missing:
  v: If missing, this task should be performed with normal priority
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: CommunicationPriority
  strength:
    v: required
  description:
    v: Codes indicating the relative importance of a communication request.
  value set:
    v: http://hl7.org/fhir/ValueSet/request-priority|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: workflow
  map:
    v: Request.priority
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.grade

id:
  v: CommunicationRequest.doNotPerform
path:
  v: CommunicationRequest.doNotPerform
short:
  v: True if request is prohibiting action
definition:
  v: If true indicates that the CommunicationRequest is asking for the specified action to *not* occur.
comment:
  v: The attributes provided with the request qualify what is not to be done.
alias:
  v: prohibited
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.doNotPerform
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
meaning when missing:
  v: If do not perform is not specified, the request is a positive request e.g. "do perform"
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: If true this element negates the specified action. For Example, instead of a request for a communication, it is a request for the communication to not occur.
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.doNotPerform

id:
  v: CommunicationRequest.medium
path:
  v: CommunicationRequest.medium
short:
  v: A channel of communication
definition:
  v: A channel that was used for this communication (e.g. email, fax).
min:
  v: 1
max:
  v: *
base:
  path:
    v: CommunicationRequest.medium
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  strength:
    v: required
  value set:
    v: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
    link: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset

id:
  v: CommunicationRequest.subject
path:
  v: CommunicationRequest.subject
short:
  v: Focus of message
definition:
  v: The patient or group that is the focus of this communication request.
alias:
  v: patient
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.subject
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Request.subject
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject[x]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject

id:
  v: CommunicationRequest.about
path:
  v: CommunicationRequest.about
short:
  v: Resources that pertain to this communication request
definition:
  v: Other resources that pertain to this communication request and to which this communication request should be associated.
comment:
  v: Don't use CommunicationRequest.about element when a more specific element exists, such as basedOn, reasonReference, or replaces.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.about
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    link: http://hl7.org/fhir/StructureDefinition/Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Request.supportingInfo
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.context

id:
  v: CommunicationRequest.encounter
path:
  v: CommunicationRequest.encounter
short:
  v: Encounter created as part of
definition:
  v: The Encounter during which this CommunicationRequest was created or to which the creation of this record is tightly associated.
comment:
  v: This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.encounter
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Encounter
    link: http://hl7.org/fhir/StructureDefinition/Encounter
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.context
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.context

id:
  v: CommunicationRequest.payload
path:
  v: CommunicationRequest.payload
short:
  v: Message payload
definition:
  v: Text, attachment(s), or resource(s) to be communicated to the recipient.
min:
  v: 1
max:
  v: *
base:
  path:
    v: CommunicationRequest.payload
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.payload.id
path:
  v: CommunicationRequest.payload.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.payload.extension
path:
  v: CommunicationRequest.payload.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.payload.modifierExtension
path:
  v: CommunicationRequest.payload.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.payload.content[x]
path:
  v: CommunicationRequest.payload.content[x]
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  ordered:
    v: false
  rules:
    v: open
short:
  v: Message part content
definition:
  v: The communicated content (or for multi-part communications, one portion of the communication).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CommunicationRequest.payload.content[x]
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
type:
  code:
    v: Attachment
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    link: http://hl7.org/fhir/StructureDefinition/Resource
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Request.note

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment
path:
  v: CommunicationRequest.payload.content[x]
slice name:
  v: contentAttachment
short:
  v: Message part content
definition:
  v: The communicated content (or for multi-part communications, one portion of the communication).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.payload.content[x]
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Attachment
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Request.note

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.id
path:
  v: CommunicationRequest.payload.content[x].id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value: url
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.extension
path:
  v: CommunicationRequest.payload.content[x].extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.extension:Attachment
path:
  v: CommunicationRequest.payload.content[x].extension
slice name:
  v: Attachment
short:
  v: Attachment details
definition:
  v: Extra details for attachment to help with rendering
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
    link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.contentType
path:
  v: CommunicationRequest.payload.content[x].contentType
short:
  v: Mime type of the content, with charset etc.
definition:
  v: Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.
requirements:
  v: Processors of the data need to be able to know how to interpret the data.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.contentType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
example:
  label:
    v: General
  value: code
    v: text/plain; charset=UTF-8, image/png
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: MimeType
  strength:
    v: required
  description:
    v: The mime type of an attachment. Any valid mime type is allowed.
  value set:
    v: http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
    link: 4.0
    link: .1
mapping:
  identity:
    v: v2
  map:
    v: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
mapping:
  identity:
    v: rim
  map:
    v: ./mediaType, ./charset

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.language
path:
  v: CommunicationRequest.payload.content[x].language
short:
  v: Human language of the content (BCP-47)
definition:
  v: The human language of the content. The value can be any valid value according to BCP 47.
requirements:
  v: Users need to be able to choose between the languages in a set of attachments.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
example:
  label:
    v: General
  value: code
    v: en-AU
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value: canonical
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages
mapping:
  identity:
    v: rim
  map:
    v: ./language

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.data
path:
  v: CommunicationRequest.payload.content[x].data
short:
  v: Data inline, base64ed
definition:
  v: The actual data of the attachment - a sequence of bytes, base64 encoded.
comment:
  v: The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.
requirements:
  v: The data needs to able to be transmitted inline.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.data
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: ED.5
mapping:
  identity:
    v: rim
  map:
    v: ./data

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.url
path:
  v: CommunicationRequest.payload.content[x].url
short:
  v: Uri where the data can be found
definition:
  v: A location where the data can be accessed.
comment:
  v: If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.
requirements:
  v: The data needs to be transmitted by reference.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.url
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: url
example:
  label:
    v: General
  value: url
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: RP.1+RP.2 - if they refer to a URL (see v2.6)
mapping:
  identity:
    v: rim
  map:
    v: ./reference/literal

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.size
path:
  v: CommunicationRequest.payload.content[x].size
short:
  v: Number of bytes of content (if url provided)
definition:
  v: The number of bytes of data that make up this attachment (before base64 encoding, if that is done).
comment:
  v: The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.
requirements:
  v: Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.size
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: unsignedInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A (needs data type R3 proposal)

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.hash
path:
  v: CommunicationRequest.payload.content[x].hash
short:
  v: Hash of the data (sha-1, base64ed)
definition:
  v: The calculated hash of the data using SHA-1. Represented using base64.
comment:
  v: The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see [Provenance.signature](http://hl7.org/fhir/R4/provenance-definitions.html#Provenance.signature) for mechanism to protect a resource with a digital signature.
requirements:
  v: Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.hash
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: base64Binary
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.title
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
  value: boolean
    v: true
path:
  v: CommunicationRequest.payload.content[x].title
short:
  v: Label to display in place of the data
definition:
  v: A label or set of text to display in place of the data.
requirements:
  v: Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.title
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
example:
  label:
    v: General
  value: string
    v: Official Corporate Logo
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: ./title/data

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.creation
path:
  v: CommunicationRequest.payload.content[x].creation
short:
  v: Date attachment was first created
definition:
  v: The date that the attachment was first created.
requirements:
  v: This is often tracked as an integrity issue for use of the attachment.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Attachment.creation
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A (needs data type R3 proposal)

id:
  v: CommunicationRequest.occurrence[x]
path:
  v: CommunicationRequest.occurrence[x]
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  ordered:
    v: false
  rules:
    v: open
short:
  v: When scheduled
definition:
  v: The time when this communication is to occur.
alias:
  v: timing
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.occurrence[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
type:
  code:
    v: Period
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.occurrence[x]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.planned

id:
  v: CommunicationRequest.occurrence[x]:occurrenceDateTime
path:
  v: CommunicationRequest.occurrence[x]
slice name:
  v: occurrenceDateTime
short:
  v: Must be in UTC timezone on the FHIR server
definition:
  v: The time when this communication is to occur.
alias:
  v: timing
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.occurrence[x]
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.occurrence[x]
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.planned

id:
  v: CommunicationRequest.authoredOn
path:
  v: CommunicationRequest.authoredOn
short:
  v: Must be in UTC timezone on the FHIR server
definition:
  v: For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
alias:
  v: createdOn
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.authoredOn
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.authoredOn
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.recorded

id:
  v: CommunicationRequest.requester
path:
  v: CommunicationRequest.requester
short:
  v: Who/what is requesting service
definition:
  v: The device, individual, or organization who initiated the request and has responsibility for its activation.
alias:
  v: author
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.requester
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    link: http://hl7.org/fhir/StructureDefinition/PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    link: http://hl7.org/fhir/StructureDefinition/Device
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.requester
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.author
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=AUT].role

id:
  v: CommunicationRequest.recipient
path:
  v: CommunicationRequest.recipient
short:
  v: Message recipient
definition:
  v: The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.recipient
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Request.performer
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.actor

id:
  v: CommunicationRequest.sender
path:
  v: CommunicationRequest.sender
short:
  v: Message sender
definition:
  v: The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.sender
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Device
    link: http://hl7.org/fhir/StructureDefinition/Device
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    link: http://hl7.org/fhir/StructureDefinition/PractitionerRole
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/HealthcareService
    link: http://hl7.org/fhir/StructureDefinition/HealthcareService
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.performer
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.actor

id:
  v: CommunicationRequest.reasonCode
path:
  v: CommunicationRequest.reasonCode
short:
  v: Why is communication needed?
definition:
  v: Describes why the request is being made in coded or textual form.
comment:
  v: Textual reasons can be captured using reasonCode.text.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.reasonCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value: string
      v: CommunicationReason
  strength:
    v: example
  description:
    v: Codes for describing reasons for the occurrence of a communication.
  value set:
    v: http://terminology.hl7.org/ValueSet/v3-ActReason
    link: http://terminology.hl7.org/ValueSet/v3-ActReason
mapping:
  identity:
    v: workflow
  map:
    v: Request.reasonCode
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]
mapping:
  identity:
    v: rim
  map:
    v: .reasonCode

id:
  v: CommunicationRequest.reasonReference
path:
  v: CommunicationRequest.reasonReference
short:
  v: Why is communication needed?
definition:
  v: Indicates another resource whose existence justifies this request.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.reasonReference
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Condition
    link: http://hl7.org/fhir/StructureDefinition/Condition
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Observation
    link: http://hl7.org/fhir/StructureDefinition/Observation
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DiagnosticReport
    link: http://hl7.org/fhir/StructureDefinition/DiagnosticReport
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/DocumentReference
    link: http://hl7.org/fhir/StructureDefinition/DocumentReference
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.reasonReference
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target

id:
  v: CommunicationRequest.note
path:
  v: CommunicationRequest.note
short:
  v: Comments made about communication request
definition:
  v: Comments made about the request by the requester, sender, recipient, subject or other participants.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.note
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Annotation
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: workflow
  map:
    v: Request.note
mapping:
  identity:
    v: rim
  map:
    v: .inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]

element:
  id:
    v: CommunicationRequest
  path:
    v: CommunicationRequest
element:
  id:
    v: CommunicationRequest.meta.profile
  path:
    v: CommunicationRequest.meta.profile
  min:
    v: 1
  max:
    v: 1
element:
  id:
    v: CommunicationRequest.contained
  path:
    v: CommunicationRequest.contained
  max:
    v: 0
element:
  id:
    v: CommunicationRequest.extension
  path:
    v: CommunicationRequest.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
  min:
    v: 1
element:
  id:
    v: CommunicationRequest.extension:Campaign
  path:
    v: CommunicationRequest.extension
  slice name:
    v: Campaign
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
      link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-campaign-extension
element:
  id:
    v: CommunicationRequest.extension:ContactPoint
  path:
    v: CommunicationRequest.extension
  slice name:
    v: ContactPoint
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
      link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-contact-point-extension
element:
  id:
    v: CommunicationRequest.extension:CallbackUrl
  path:
    v: CommunicationRequest.extension
  slice name:
    v: CallbackUrl
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
      link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-callback-url-extension
element:
  id:
    v: CommunicationRequest.extension:Reply
  path:
    v: CommunicationRequest.extension
  slice name:
    v: Reply
  min:
    v: 0
  max:
    v: 1
  type:
    code:
      v: Extension
    profile:
      v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
      link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-system-reply-extension
element:
  id:
    v: CommunicationRequest.identifier
  path:
    v: CommunicationRequest.identifier
  min:
    v: 1
element:
  id:
    v: CommunicationRequest.identifier.use
  path:
    v: CommunicationRequest.identifier.use
  min:
    v: 1
element:
  id:
    v: CommunicationRequest.identifier.system
  path:
    v: CommunicationRequest.identifier.system
  min:
    v: 1
element:
  id:
    v: CommunicationRequest.identifier.value
  path:
    v: CommunicationRequest.identifier.value
  min:
    v: 1
element:
  id:
    v: CommunicationRequest.statusReason
  path:
    v: CommunicationRequest.statusReason
  binding:
    strength:
      v: required
    value set:
      v: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
      link: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-communication-delivery-status-valueset
element:
  id:
    v: CommunicationRequest.medium
  path:
    v: CommunicationRequest.medium
  min:
    v: 1
  binding:
    strength:
      v: required
    value set:
      v: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
      link: https://fhir-ig.digital.health.nz/shared-care/ValueSet/hnz-participation-mode-valueset
element:
  id:
    v: CommunicationRequest.subject
  path:
    v: CommunicationRequest.subject
  type:
    code:
      v: Reference
    target profile:
      v: http://hl7.org/fhir/StructureDefinition/Patient
      link: http://hl7.org/fhir/StructureDefinition/Patient
element:
  id:
    v: CommunicationRequest.payload
  path:
    v: CommunicationRequest.payload
  min:
    v: 1
element:
  id:
    v: CommunicationRequest.payload.content[x]
  path:
    v: CommunicationRequest.payload.content[x]
  slicing:
    discriminator:
      type:
        v: type
      path:
        v: $this
    ordered:
      v: false
    rules:
      v: open
element:
  id:
    v: CommunicationRequest.payload.content[x]:contentAttachment
  path:
    v: CommunicationRequest.payload.content[x]
  slice name:
    v: contentAttachment
  min:
    v: 0
  max:
    v: 1

code:
  v: Attachment

id:
  v: CommunicationRequest.payload.content[x]:contentAttachment.extension:Attachment
path:
  v: CommunicationRequest.payload.content[x].extension
slice name:
  v: Attachment
min:
  v: 0
max:
  v: 1
type:
  code:
    v: Extension
  profile:
    v: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension
    link: https://fhir-ig.digital.health.nz/shared-care/StructureDefinition/hnz-attachment-extension

id:
  v: CommunicationRequest.occurrence[x]
path:
  v: CommunicationRequest.occurrence[x]
slicing:
  discriminator:
    type:
      v: type
    path:
      v: $this
  ordered:
    v: false
  rules:
    v: open

id:
  v: CommunicationRequest.occurrence[x]:occurrenceDateTime
path:
  v: CommunicationRequest.occurrence[x]
slice name:
  v: occurrenceDateTime
short:
  v: Must be in UTC timezone on the FHIR server
min:
  v: 0
max:
  v: 1
type:
  code:
    v: dateTime

id:
  v: CommunicationRequest.authoredOn
path:
  v: CommunicationRequest.authoredOn
short:
  v: Must be in UTC timezone on the FHIR server

id:
  v: CommunicationRequest.recipient
path:
  v: CommunicationRequest.recipient
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner