Advance Care Planning (PZP)
1.0.0-rc2 - trial-use

Advance Care Planning (PZP) - Downloaded Version 1.0.0-rc2 See the Directory of published versions

## Resource Profile: ACP Request to Inform Relatives

Official URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-InformRelativesRequest | Version: 1.0.0-rc2
Draft as of 2026-03-03 | Computable Name: ACPInformRelativesRequest
Copyright/Legal: 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.

A CommunicationRequest representing the advice or instruction given to the patient to discuss their advance care planning (ACP) and treatment agreements with their relatives or proxies.

Usages:

- Examples for this Profile: CommunicationRequest/ACP-InformRelativesRequest-Pat1 and CommunicationRequest/ACP-InformRelativesRequest-Pat2
- CapabilityStatements using this Profile: ACP CapabilityStatement Consulter and ACP CapabilityStatement Provider

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest(4.0.1) | A request for information to be sent to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
category | O | 1..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 223449006
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
subject | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Focus of message
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
encounter | O Σ | 0..1 | Reference(ACP Encounter(1.0.0-rc2)) | Encounter created as part of
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
authoredOn | O Σ | 0..1 | dateTime | When request transitioned to being actionable
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
requester | O Σ | 0..1 | Reference(ACP HealthProfessional PractitionerRole(1.0.0-rc2) | ACP HealthProfessional Practitioner(1.0.0-rc2)) | Who/what is requesting service
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
recipient | O | 0..* | Reference(ACP ContactPerson(1.0.0-rc2)) | Message recipient
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
sender | O Σ | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Message sender
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
reasonCode | O Σ | 1..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 713603004
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std.
CommunicationRequest.​reasonCode | Base | example | v3 Code System ActReason | 📍3.0.0 | THO v7.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | CommunicationRequest.implicitRules, CommunicationRequest.modifierExtension, CommunicationRequest.status, CommunicationRequest.category, CommunicationRequest.doNotPerform, CommunicationRequest.subject, CommunicationRequest.encounter, CommunicationRequest.authoredOn, CommunicationRequest.requester, CommunicationRequest.recipient, CommunicationRequest.sender, CommunicationRequest.reasonCode | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from CommunicationRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest(4.0.1) | A request for information to be sent to a receiver
category | O | 1..* | CodeableConcept | Message category Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 223449006
subject | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Focus of message
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
encounter | O | 0..1 | Reference(ACP Encounter(1.0.0-rc2)) | Encounter created as part of
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
authoredOn | O | 0..1 | dateTime | When request transitioned to being actionable
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
requester | O | 0..1 | Reference(ACP HealthProfessional PractitionerRole(1.0.0-rc2) | ACP HealthProfessional Practitioner(1.0.0-rc2)) | Who/what is requesting service
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
recipient | O | 0..* | Reference(ACP ContactPerson(1.0.0-rc2)) | Message recipient
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
sender | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Message sender
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
reasonCode | O | 1..* | CodeableConcept | Why is communication needed? Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 713603004
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest(4.0.1) | A request for information to be sent to a receiver
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier | Σ | 0..* | Identifier | Unique identifier
basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal
replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request.
category | O | 1..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 223449006
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Focus of message
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication request
encounter | O Σ | 0..1 | Reference(ACP Encounter(1.0.0-rc2)) | Encounter created as part of
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
payload |  | 0..* | BackboneElement | Message payload
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
content[x] |  | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
occurrence[x] | Σ | 0..1 |  | When scheduled
occurrenceDateTime |  |  | dateTime |
occurrencePeriod |  |  | Period |
authoredOn | O Σ | 0..1 | dateTime | When request transitioned to being actionable
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
requester | O Σ | 0..1 | Reference(ACP HealthProfessional PractitionerRole(1.0.0-rc2) | ACP HealthProfessional Practitioner(1.0.0-rc2)) | Who/what is requesting service
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
recipient | O | 0..* | Reference(ACP ContactPerson(1.0.0-rc2)) | Message recipient
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
sender | O Σ | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Message sender
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
reasonCode | O Σ | 1..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 713603004
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​statusReason | Base | example |  | Not State | Unknown
CommunicationRequest.​category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std.
CommunicationRequest.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
CommunicationRequest.​medium | Base | example | ParticipationMode | 📍3.0.0 | THO v7.0
CommunicationRequest.​reasonCode | Base | example | v3 Code System ActReason | 📍3.0.0 | THO v7.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | CommunicationRequest.meta, CommunicationRequest.implicitRules, CommunicationRequest.language, CommunicationRequest.text, CommunicationRequest.extension, CommunicationRequest.modifierExtension, CommunicationRequest.identifier, CommunicationRequest.basedOn, CommunicationRequest.replaces, CommunicationRequest.groupIdentifier, CommunicationRequest.status, CommunicationRequest.statusReason, CommunicationRequest.category, CommunicationRequest.priority, CommunicationRequest.doNotPerform, CommunicationRequest.medium, CommunicationRequest.subject, CommunicationRequest.about, CommunicationRequest.encounter, CommunicationRequest.payload, CommunicationRequest.payload.extension, CommunicationRequest.payload.modifierExtension, CommunicationRequest.payload.content[x], CommunicationRequest.occurrence[x], CommunicationRequest.authoredOn, CommunicationRequest.requester, CommunicationRequest.recipient, CommunicationRequest.sender, CommunicationRequest.reasonCode, CommunicationRequest.reasonReference, CommunicationRequest.note | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | CommunicationRequest.extension, CommunicationRequest.modifierExtension, CommunicationRequest.payload.extension, CommunicationRequest.payload.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from CommunicationRequest

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

- ACP Patient (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Patient|1.0.0-rc2)
- ACP Encounter (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Encounter|1.0.0-rc2)
- ACP HealthProfessional PractitionerRole (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-HealthProfessional-PractitionerRole|1.0.0-rc2)
- ACP HealthProfessional Practitioner (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-HealthProfessional-Practitioner|1.0.0-rc2)
- ACP ContactPerson (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-ContactPerson|1.0.0-rc2)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest(4.0.1) | A request for information to be sent to a receiver
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
category | O | 1..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 223449006
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
subject | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Focus of message
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
encounter | O Σ | 0..1 | Reference(ACP Encounter(1.0.0-rc2)) | Encounter created as part of
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
authoredOn | O Σ | 0..1 | dateTime | When request transitioned to being actionable
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
requester | O Σ | 0..1 | Reference(ACP HealthProfessional PractitionerRole(1.0.0-rc2) | ACP HealthProfessional Practitioner(1.0.0-rc2)) | Who/what is requesting service
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
recipient | O | 0..* | Reference(ACP ContactPerson(1.0.0-rc2)) | Message recipient
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
sender | O Σ | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Message sender
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
reasonCode | O Σ | 1..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 713603004
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std.
CommunicationRequest.​reasonCode | Base | example | v3 Code System ActReason | 📍3.0.0 | THO v7.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | CommunicationRequest.implicitRules, CommunicationRequest.modifierExtension, CommunicationRequest.status, CommunicationRequest.category, CommunicationRequest.doNotPerform, CommunicationRequest.subject, CommunicationRequest.encounter, CommunicationRequest.authoredOn, CommunicationRequest.requester, CommunicationRequest.recipient, CommunicationRequest.sender, CommunicationRequest.reasonCode | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | CommunicationRequest.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from CommunicationRequest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest(4.0.1) | A request for information to be sent to a receiver
category | O | 1..* | CodeableConcept | Message category Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 223449006
subject | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Focus of message
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
encounter | O | 0..1 | Reference(ACP Encounter(1.0.0-rc2)) | Encounter created as part of
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
authoredOn | O | 0..1 | dateTime | When request transitioned to being actionable
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
requester | O | 0..1 | Reference(ACP HealthProfessional PractitionerRole(1.0.0-rc2) | ACP HealthProfessional Practitioner(1.0.0-rc2)) | Who/what is requesting service
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
recipient | O | 0..* | Reference(ACP ContactPerson(1.0.0-rc2)) | Message recipient
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
sender | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Message sender
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
reasonCode | O | 1..* | CodeableConcept | Why is communication needed? Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 713603004
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
CommunicationRequest |  | 0..* | CommunicationRequest(4.0.1) | A request for information to be sent to a receiver
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1
identifier | Σ | 0..* | Identifier | Unique identifier
basedOn | Σ | 0..* | Reference(Resource) | Fulfills plan or proposal
replaces | Σ | 0..* | Reference(CommunicationRequest) | Request(s) replaced by this request
groupIdentifier | Σ | 0..1 | Identifier | Composite request this is part of
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of the communication request.
statusReason |  | 0..1 | CodeableConcept | Reason for current status Binding Description: (example): Codes identifying the reason for the current state of a request.
category | O | 1..* | CodeableConcept | Message category Binding: CommunicationCategory (example): Codes for general categories of communications such as alerts, instruction, etc. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 223449006
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Codes indicating the relative importance of a communication request.
doNotPerform | ?!Σ | 0..1 | boolean | True if request is prohibiting action
medium |  | 0..* | CodeableConcept | A channel of communication Binding: ParticipationMode (3.0.0) (example): Codes for communication mediums such as phone, fax, email, in person, etc.
subject | O | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Focus of message
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
about |  | 0..* | Reference(Resource) | Resources that pertain to this communication request
encounter | O Σ | 0..1 | Reference(ACP Encounter(1.0.0-rc2)) | Encounter created as part of
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
payload |  | 0..* | BackboneElement | Message payload
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Constraints: ext-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1
content[x] |  | 1..1 |  | Message part content
contentString |  |  | string |
contentAttachment |  |  | Attachment |
contentReference |  |  | Reference(Resource) |
occurrence[x] | Σ | 0..1 |  | When scheduled
occurrenceDateTime |  |  | dateTime |
occurrencePeriod |  |  | Period |
authoredOn | O Σ | 0..1 | dateTime | When request transitioned to being actionable
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
requester | O Σ | 0..1 | Reference(ACP HealthProfessional PractitionerRole(1.0.0-rc2) | ACP HealthProfessional Practitioner(1.0.0-rc2)) | Who/what is requesting service
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
recipient | O | 0..* | Reference(ACP ContactPerson(1.0.0-rc2)) | Message recipient
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
sender | O Σ | 0..1 | Reference(ACP Patient(1.0.0-rc2)) | Message sender
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
reasonCode | O Σ | 1..* | CodeableConcept | Why is communication needed? Binding: ActReason (3.0.0) (example): Codes for describing reasons for the occurrence of a communication. Required Pattern: At least the following
Obligations | Actor
SHALL:populate-if-known | ACP Actor Provider
SHALL:no-error | ACP Actor Consulter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 713603004
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why is communication needed?
note |  | 0..* | Annotation | Comments made about communication request
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
CommunicationRequest.​language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
CommunicationRequest.​status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std.
CommunicationRequest.​statusReason | Base | example |  | Not State | Unknown
CommunicationRequest.​category | Base | example | CommunicationCategory | 📍4.0.1 | FHIR Std.
CommunicationRequest.​priority | Base | required | Request priority | 📍4.0.1 | FHIR Std.
CommunicationRequest.​medium | Base | example | ParticipationMode | 📍3.0.0 | THO v7.0
CommunicationRequest.​reasonCode | Base | example | v3 Code System ActReason | 📍3.0.0 | THO v7.0

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | CommunicationRequest | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | CommunicationRequest | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | CommunicationRequest | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | CommunicationRequest.meta, CommunicationRequest.implicitRules, CommunicationRequest.language, CommunicationRequest.text, CommunicationRequest.extension, CommunicationRequest.modifierExtension, CommunicationRequest.identifier, CommunicationRequest.basedOn, CommunicationRequest.replaces, CommunicationRequest.groupIdentifier, CommunicationRequest.status, CommunicationRequest.statusReason, CommunicationRequest.category, CommunicationRequest.priority, CommunicationRequest.doNotPerform, CommunicationRequest.medium, CommunicationRequest.subject, CommunicationRequest.about, CommunicationRequest.encounter, CommunicationRequest.payload, CommunicationRequest.payload.extension, CommunicationRequest.payload.modifierExtension, CommunicationRequest.payload.content[x], CommunicationRequest.occurrence[x], CommunicationRequest.authoredOn, CommunicationRequest.requester, CommunicationRequest.recipient, CommunicationRequest.sender, CommunicationRequest.reasonCode, CommunicationRequest.reasonReference, CommunicationRequest.note | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | CommunicationRequest.extension, CommunicationRequest.modifierExtension, CommunicationRequest.payload.extension, CommunicationRequest.payload.modifierExtension | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from CommunicationRequest

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

- ACP Patient (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Patient|1.0.0-rc2)
- ACP Encounter (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Encounter|1.0.0-rc2)
- ACP HealthProfessional PractitionerRole (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-HealthProfessional-PractitionerRole|1.0.0-rc2)
- ACP HealthProfessional Practitioner (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-HealthProfessional-Practitioner|1.0.0-rc2)
- ACP ContactPerson (https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-ContactPerson|1.0.0-rc2)

Other representations of profile: CSV, Excel, Schematron