ACP-InformRelativesRequest
type: StructureDefinition
node role: treeRoot
id:
  v: ACP-InformRelativesRequest
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition ACP-InformRelativesRequest 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; category 1..* CodeableConcept Message category Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://snomed.info/sct #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: 223449006 #xD; subject 0..1 Reference(Patient(1.0.0-rc1)) Focus of message #xD; recipient 0..* Reference(ContactPerson(1.0.0-rc1)) Message recipient #xD; authoredOn 0..1 dateTime When request transitioned to being actionable #xD; sender 0..1 Reference(Patient(1.0.0-rc1)) Message sender #xD; requester #xD; agent 1..1 Reference(HealthProfessional Practitioner(1.0.0-rc1)) Individual making the request #xD; Slices for extension Content/Rules for all slices #xD; extension:practitionerRole 0..* Reference(nl-core-practitionerrole) Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference #xD; reasonCode 1..1 CodeableConcept Why is communication needed? Required Pattern: At least the following #xD; coding 1..* Coding Code defined by a terminology system Fixed Value: (Complex) #xD; system 1..1 uri Identity of the terminology system Fixed Value: http://snomed.info/sct #xD; code 1..1 code Symbol in syntax defined by the system Fixed Value: 713603004 #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-InformRelativesRequest
  l: ACP-InformRelativesRequest
version:
  v: 1.0.0-rc1
name:
  v: ACPInformRelativesRequest
title:
  v: Inform Relatives Request
status:
  v: draft
experimental:
  v: false
date:
  v: 2026-02-03T12:30:20+00:00
publisher:
  v: IKNL
contact:
  telecom:
    system:
      v: url
    value:
      v: https://www.iknl.nl
description:
  v: Communication events that have taken place in context of Advance Care Planning. Based on Communication resource.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
      l: m49.htm
    code:
      v: 001
copyright:
  v: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.
fhir version:
  v: 3.0.2
mapping:
  identity:
    v: pall-izppz-zib2017v2025-03-11
  uri:
    v: https://decor.nictiz.nl/exist/apps/api/dataset/2.16.840.1.113883.2.4.3.11.60.117.1.1/2020-07-29T10%3A37%3A48/$view
    l: https://decor.nictiz.nl/exist/apps/api/dataset/2.16.840.1.113883.2.4.3.11.60.117.1.1/2020-07-29T10%3A37%3A48/$view
  name:
    v: ACP zib2017 dataset
kind:
  v: resource
abstract:
  v: false
type:
  v: CommunicationRequest
base definition:
  v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
  l: CommunicationRequest
derivation:
  v: constraint
snapshot:
  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
        l: DomainResource
    constraint:
      key:
        v: dom-1
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain any narrative
      expression:
        v: contained.text.empty()
      xpath:
        v: not(parent::f:contained and f:text)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: 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
        l: 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
      expression:
        v: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
      xpath:
        v: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        l: DomainResource
    mapping:
      identity:
        v: pall-izppz-zib2017v2025-03-11
      map:
        v: 187
      comment:
        v: Heeft u patient geïnformeerd over eigen verantwoordelijkheid om deze behandelafspraken met naasten te bespreken?
    mapping:
      identity:
        v: rim
      map:
        v: Entity. Role, or Act
    mapping:
      identity:
        v: workflow
      map:
        v: Request
    mapping:
      identity:
        v: w5
      map:
        v: workflow.order
  element:
    id:
      v: CommunicationRequest.id
    path:
      v: CommunicationRequest.id
    short:
      v: Logical id of this artifact
    definition:
      v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
    comment:
      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.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Resource.id
      min:
        v: 0
      max:
        v: 1
    type:
      code:
        v: id
        l: id
    is summary:
      v: true
  element:
    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 may not always be associated with version changes to the resource.
    min:
      v: 0

v: 1

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

code:
  v: Meta
  l: Meta

v: true

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.
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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
    l: uri
is modifier:
  v: true
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
    l: code
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
      l: elementdefinition-maxValueSet
    value: Reference
      l: 3.0
      l: .2
      reference:
        v: http://hl7.org/fhir/ValueSet/all-languages|3.0.2
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: Language
  strength:
    v: extensible
  description:
    v: A human language.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/languages|3.0.2

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 may 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 in formation 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
    l: Narrative
condition:
  v: dom-1
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.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
    l: Resource
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.extension
path:
  v: CommunicationRequest.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 resource. In order 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.
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: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: N/A

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. Usually modifier elements provide negation or qualification. In order 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.
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: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.identifier
path:
  v: CommunicationRequest.identifier
short:
  v: Unique identifier
definition:
  v: A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.identifier
mapping:
  identity:
    v: w5
  map:
    v: id

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
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
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
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
    l: CommunicationRequest
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
    l: Identifier
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 | suspended | cancelled | completed | entered-in-error | unknown
definition:
  v: The status of the proposal or order.
comment:
  v: This element is labeled as a modifier because the status contains the codes cancelled and entered-in-error that mark the request as not currently valid.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CommunicationRequest.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
    l: code
is modifier:
  v: true
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: CommunicationRequestStatus
  strength:
    v: required
  description:
    v: The status of the communication request.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/request-status|3.0.2
mapping:
  identity:
    v: workflow
  map:
    v: Request.status
mapping:
  identity:
    v: w5
  map:
    v: status

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: The `category.text` element may be used to provide additional context for human readers next to the pattern category coding, for example: 'Request for patient to inform relatives about treatment agreements'.
min:
  v: 1
max:
  v: *
base:
  path:
    v: CommunicationRequest.category
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
pattern: CodeableConcept
  coding: http://snomed.info/id/223449006
    system:
      v: http://snomed.info/sct
      l: sct
    code:
      v: 223449006
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: CommunicationCategory
  strength:
    v: example
  description:
    v: Codes for general categories of communications such as alerts, instruction, etc.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/communication-category|3.0.2
mapping:
  identity:
    v: workflow
  map:
    v: Request.code
mapping:
  identity:
    v: w5
  map:
    v: class

id:
  v: CommunicationRequest.priority
path:
  v: CommunicationRequest.priority
short:
  v: Message urgency
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
    l: code
meaning when missing:
  v: If missing, this task should be performed with normal priority
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: CommunicationPriority
  strength:
    v: required
  description:
    v: Codes indicating the relative importance of a communication request.
  value set: Reference
    l: 3.0
    l: .2
    reference:
      v: http://hl7.org/fhir/ValueSet/request-priority|3.0.2
mapping:
  identity:
    v: workflow
  map:
    v: Request.priority
mapping:
  identity:
    v: w5
  map:
    v: grade

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: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.medium
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: CommunicationMedium
  strength:
    v: example
  description:
    v: Codes for communication mediums such as phone, fax, email, in person, etc.
  value set: Reference
    l: 2016
    l: -11
    reference:
      v: http://hl7.org/fhir/ValueSet/v3-ParticipationMode|2016-11-11

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
    l: Reference
  target profile:
    v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient|1.0.0-rc1
    l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient
mapping:
  identity:
    v: workflow
  map:
    v: Request.subject
mapping:
  identity:
    v: w5
  map:
    v: who.focus

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
    l: Reference
  target profile:
    v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson|1.0.0-rc1
    l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson
mapping:
  identity:
    v: workflow
  map:
    v: Request.performer
mapping:
  identity:
    v: w5
  map:
    v: who.focus

id:
  v: CommunicationRequest.topic
path:
  v: CommunicationRequest.topic
short:
  v: Focal resources
definition:
  v: The resources which were related to producing this communication request.
min:
  v: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.topic
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
mapping:
  identity:
    v: workflow
  map:
    v: Request.supportingInfo
mapping:
  identity:
    v: w5
  map:
    v: context

id:
  v: CommunicationRequest.context
path:
  v: CommunicationRequest.context
short:
  v: Encounter or episode leading to message
definition:
  v: The encounter or episode of care within which the communication request was created.
alias:
  v: encounter
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.context
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Encounter
    l: Encounter
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/EpisodeOfCare
    l: EpisodeOfCare
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.context
mapping:
  identity:
    v: w5
  map:
    v: 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: 0
max:
  v: *
base:
  path:
    v: CommunicationRequest.payload
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: CommunicationRequest.payload.id
path:
  v: CommunicationRequest.payload.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
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. In order 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.
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
    l: Extension
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
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 that contains it. Usually modifier elements provide negation or qualification. In order 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.
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
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.payload.content[x]
path:
  v: CommunicationRequest.payload.content[x]
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
    l: string
type:
  code:
    v: Attachment
    l: Attachment
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Resource
    l: Resource
mapping:
  identity:
    v: workflow
  map:
    v: Request.supportingInfo IF Reference, Request.note if string; No mapping if Attachment

id:
  v: CommunicationRequest.occurrence[x]
path:
  v: CommunicationRequest.occurrence[x]
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
    l: dateTime
type:
  code:
    v: Period
    l: Period
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.occurrence
mapping:
  identity:
    v: w5
  map:
    v: when.planned

id:
  v: CommunicationRequest.authoredOn
path:
  v: CommunicationRequest.authoredOn
short:
  v: When request transitioned to being actionable
definition:
  v: For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.
comment:
  v: Indicate the date and preferrably time when the request was sent
alias:
  v: createdOn
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.authoredOn
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.authoredOn
mapping:
  identity:
    v: w5
  map:
    v: when.recorded

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
    l: Reference
  target profile:
    v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient|1.0.0-rc1
    l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient
mapping:
  identity:
    v: workflow
  map:
    v: Request.requester.agent
mapping:
  identity:
    v: w5
  map:
    v: who.actor

id:
  v: CommunicationRequest.requester
path:
  v: CommunicationRequest.requester
short:
  v: Who/what is requesting service
definition:
  v: The individual 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: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() | (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: cmr-1
  severity:
    v: error
  human:
    v: onBehalfOf can only be specified if agent is practitioner or device
  expression:
    v: (agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not()
  xpath:
    v: contains(f:agent/f:reference/@value, '/Practitioner/') or contains(f:agent/f:reference/@value, '/Device/') or not(exists(f:onBehalfOf))
  source:
    v: http://hl7.org/fhir/StructureDefinition/CommunicationRequest
    l: CommunicationRequest
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.requester
mapping:
  identity:
    v: rim
  map:
    v: .participation[typeCode=AUT].role

id:
  v: CommunicationRequest.requester.id
path:
  v: CommunicationRequest.requester.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.requester.extension
path:
  v: CommunicationRequest.requester.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. In order 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.requester.modifierExtension
path:
  v: CommunicationRequest.requester.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 element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.
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
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
is modifier:
  v: true
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.requester.agent
path:
  v: CommunicationRequest.requester.agent
short:
  v: Individual making the request
definition:
  v: The device, practitioner, etc. who initiated the request.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CommunicationRequest.requester.agent
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner|1.0.0-rc1
    l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.requester.agent
mapping:
  identity:
    v: rim
  map:
    v: .player
mapping:
  identity:
    v: w5
  map:
    v: who.author

id:
  v: CommunicationRequest.requester.agent.id
path:
  v: CommunicationRequest.requester.agent.id
representation:
  v: xmlAttr
short:
  v: xml:id (or equivalent in JSON)
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:
  code:
    v: string
    l: string
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.requester.agent.extension
path:
  v: CommunicationRequest.requester.agent.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. In order 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.
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
    l: Extension
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: CommunicationRequest.requester.agent.extension:practitionerRole
path:
  v: CommunicationRequest.requester.agent.extension
slice name:
  v: practitionerRole
short:
  v: Optional Extensions Element
definition:
  v: Optional Extension Element - found in all resources.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
  profile:
    v: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference|1.0.2
    l: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
is modifier:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.requester.agent.reference
path:
  v: CommunicationRequest.requester.agent.reference
short:
  v: Literal reference, Relative, internal or absolute URL
definition:
  v: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.
comment:
  v: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
condition:
  v: ref-1
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.requester.agent.identifier
path:
  v: CommunicationRequest.requester.agent.identifier
short:
  v: Logical reference, when literal reference is not known
definition:
  v: An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
comment:
  v: When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
    l: Identifier
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .identifier

id:
  v: CommunicationRequest.requester.agent.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
    l: elementdefinition-translatable
  value: Boolean
    v: true
path:
  v: CommunicationRequest.requester.agent.display
short:
  v: Text alternative for the resource
definition:
  v: Plain text narrative that identifies the resource in addition to the resource reference.
comment:
  v: This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: CommunicationRequest.requester.onBehalfOf
path:
  v: CommunicationRequest.requester.onBehalfOf
short:
  v: Organization agent is acting for
definition:
  v: The organization the device or practitioner was acting on behalf of.
requirements:
  v: Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: CommunicationRequest.requester.onBehalfOf
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    l: Organization
condition:
  v: cmr-1
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.requester.onBehalfOf
mapping:
  identity:
    v: rim
  map:
    v: .scoper

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 caprued using reasonCode.text.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: CommunicationRequest.reasonCode
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
    l: CodeableConcept
pattern: CodeableConcept
  coding: http://snomed.info/id/713603004
    system:
      v: http://snomed.info/sct
      l: sct
    code:
      v: 713603004
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
      l: elementdefinition-bindingName
    value: String
      v: CommunicationReason
  strength:
    v: example
  description:
    v: Codes for describing reasons for the occurrence of a communication.
  value set: Reference
    l: 2016
    l: -11
    reference:
      v: http://hl7.org/fhir/ValueSet/v3-ActReason|2016-11-11
mapping:
  identity:
    v: workflow
  map:
    v: Request.reasonCode
mapping:
  identity:
    v: rim
  map:
    v: .reasonCode
mapping:
  identity:
    v: w5
  map:
    v: why

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
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Condition
    l: Condition
type:
  code:
    v: Reference
    l: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Observation
    l: Observation
is summary:
  v: true
mapping:
  identity:
    v: workflow
  map:
    v: Request.reasonReference
mapping:
  identity:
    v: rim
  map:
    v: .outboundRelationship[typeCode=RSON].target
mapping:
  identity:
    v: w5
  map:
    v: why

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
    l: Annotation
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
  mapping:
    identity:
      v: pall-izppz-zib2017v2025-03-11
    map:
      v: 187
    comment:
      v: Heeft u patient geïnformeerd over eigen verantwoordelijkheid om deze behandelafspraken met naasten te bespreken?
element:
  id:
    v: CommunicationRequest.category
  path:
    v: CommunicationRequest.category
  comment:
    v: The `category.text` element may be used to provide additional context for human readers next to the pattern category coding, for example: 'Request for patient to inform relatives about treatment agreements'.
  min:
    v: 1
  pattern: CodeableConcept
    coding: http://snomed.info/id/223449006
      system:
        v: http://snomed.info/sct
        l: sct
      code:
        v: 223449006
element:
  id:
    v: CommunicationRequest.subject
  path:
    v: CommunicationRequest.subject
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient|1.0.0-rc1
      l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient
element:
  id:
    v: CommunicationRequest.recipient
  path:
    v: CommunicationRequest.recipient
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson|1.0.0-rc1
      l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-ContactPerson
element:
  id:
    v: CommunicationRequest.authoredOn
  path:
    v: CommunicationRequest.authoredOn
  comment:
    v: Indicate the date and preferrably time when the request was sent
element:
  id:
    v: CommunicationRequest.sender
  path:
    v: CommunicationRequest.sender
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient|1.0.0-rc1
      l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-Patient
element:
  id:
    v: CommunicationRequest.requester.agent
  path:
    v: CommunicationRequest.requester.agent
  type:
    code:
      v: Reference
      l: Reference
    target profile:
      v: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner|1.0.0-rc1
      l: https://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ACP-HealthProfessional-Practitioner
element:
  id:
    v: CommunicationRequest.requester.agent.extension:practitionerRole
  path:
    v: CommunicationRequest.requester.agent.extension
  slice name:
    v: practitionerRole
  type:
    code:
      v: Extension
      l: Extension
    profile:
      v: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference|1.0.2
      l: http://nictiz.nl/fhir/StructureDefinition/practitionerrole-reference
  is modifier:
    v: false
element:
  id:
    v: CommunicationRequest.reasonCode
  path:
    v: CommunicationRequest.reasonCode
  min:
    v: 1
  max:
    v: 1
  pattern: CodeableConcept
    coding: http://snomed.info/id/713603004
      system:
        v: http://snomed.info/sct
        l: sct
      code:
        v: 713603004