IKNL PZP STU3
1.0.0-rc1 - consultation International flag

IKNL PZP STU3, published by IKNL. This guide is not an authorized publication; it is the continuous build for version 1.0.0-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IKNL/PZP-FHIR-STU3/ and changes regularly. See the Directory of published versions

Resource Profile: ACPInformRelativesRequest - Detailed Descriptions

Draft as of 2025-12-19

Definitions for the ACP-InformRelativesRequest resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
Definition

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.

ShortA request for information to be sent to a receiver
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. CommunicationRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

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.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. CommunicationRequest.modifierExtension
Definition

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.

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. CommunicationRequest.status
Definition

The status of the proposal or order.

Shortdraft | active | suspended | cancelled | completed | entered-in-error | unknown
Comments

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.

Control1..1
BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|3.0.2
(required to http://hl7.org/fhir/ValueSet/request-status|3.0.2)

The status of the communication request.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. CommunicationRequest.category
Definition

The type of message to be sent such as alert, notification, reminder, instruction, etc.

ShortMessage category
Comments

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'.


There may be multiple axes of categorization and one communication request may serve multiple purposes.

Control10..*
BindingFor example codes, see CommunicationCategoryhttp://hl7.org/fhir/ValueSet/communication-category|3.0.2
(example to http://hl7.org/fhir/ValueSet/communication-category|3.0.2)

Codes for general categories of communications such as alerts, instruction, etc.

TypeCodeableConcept
Pattern Value{
  "coding" : [{
    "system" : "http://snomed.info/sct",
    "code" : "223449006"
  }]
}
10. CommunicationRequest.subject
Definition

The patient or group that is the focus of this communication request.

ShortFocus of message
Control0..1
TypeReference(Patient, Patient, Group)
Alternate Namespatient
12. CommunicationRequest.recipient
Definition

The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

ShortMessage recipient
Control0..*
TypeReference(ContactPerson, Device, Organization, Patient, Practitioner, RelatedPerson, Group, CareTeam)
14. CommunicationRequest.authoredOn
Definition

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

ShortWhen request transitioned to being actionable
Comments

Indicate the date and preferrably time when the request was sent

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamescreatedOn
16. CommunicationRequest.sender
Definition

The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

ShortMessage sender
Control0..1
TypeReference(Patient, Device, Organization, Patient, Practitioner, RelatedPerson)
18. CommunicationRequest.reasonCode
Definition

Describes why the request is being made in coded or textual form.

ShortWhy is communication needed?
Comments

Textual reasons can be caprued using reasonCode.text.

Control10..1*
BindingFor example codes, see ActReason|2016-11-11http://hl7.org/fhir/ValueSet/v3-ActReason|2016-11-11
(example to http://hl7.org/fhir/ValueSet/v3-ActReason|2016-11-11)

Codes for describing reasons for the occurrence of a communication.

TypeCodeableConcept
Summarytrue
Pattern Value{
  "coding" : [{
    "system" : "http://snomed.info/sct",
    "code" : "713603004"
  }]
}

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
2. CommunicationRequest.category
Comments

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'.

Control1..?
Pattern Value{
  "coding" : [{
    "system" : "http://snomed.info/sct",
    "code" : "223449006"
  }]
}
4. CommunicationRequest.subject
TypeReference(Patient)
6. CommunicationRequest.recipient
TypeReference(ContactPerson)
8. CommunicationRequest.authoredOn
Comments

Indicate the date and preferrably time when the request was sent

10. CommunicationRequest.sender
TypeReference(Patient)
12. CommunicationRequest.requester
14. CommunicationRequest.requester.agent
TypeReference(HealthProfessional Practitioner)
16. CommunicationRequest.requester.agent.extension:practitionerRole
Slice NamepractitionerRole
TypeExtension(PractitionerRole Reference) (Extension Type: Reference(nl-core-practitionerrole))
Is Modifierfalse
18. CommunicationRequest.reasonCode
Control1..1
Pattern Value{
  "coding" : [{
    "system" : "http://snomed.info/sct",
    "code" : "713603004"
  }]
}

Guidance on how to interpret the contents of this table can be foundhere

0. CommunicationRequest
Definition

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.

ShortA request for information to be sent to a receiver
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty())
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
2. CommunicationRequest.id
Definition

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

ShortLogical id of this artifact
Comments

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

Control0..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. CommunicationRequest.meta
Definition

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.

ShortMetadata about the resource
Control0..1
TypeMeta
Summarytrue
6. CommunicationRequest.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

ShortA set of rules under which this content was created
Comments

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.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
8. CommunicationRequest.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

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).

Control0..1
BindingUnless not suitable, these codes SHALL be taken from Common Languages
(extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

A human language.

Additional BindingsPurpose
All LanguagesMax Binding
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. CommunicationRequest.text
Definition

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.

ShortText summary of the resource, for human interpretation
Comments

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.

Control0..1
This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
12. CommunicationRequest.contained
Definition

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.

ShortContained, inline Resources
Comments

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.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
14. CommunicationRequest.extension
Definition

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.

ShortAdditional Content defined by implementations
Comments

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
16. CommunicationRequest.modifierExtension
Definition

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.

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
18. CommunicationRequest.identifier
Definition

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.

ShortUnique identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
20. CommunicationRequest.basedOn
Definition

A plan or proposal that is fulfilled in whole or in part by this request.

ShortFulfills plan or proposal
Control0..*
TypeReference(Resource)
Summarytrue
Requirements

Allows tracing of authorization for the request and tracking whether proposals/recommendations were acted upon.

Alternate Namesfulfills
22. CommunicationRequest.replaces
Definition

Completed or terminated request(s) whose function is taken by this new request.

ShortRequest(s) replaced by this request
Comments

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.

Control0..*
TypeReference(CommunicationRequest)
Summarytrue
Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple requests.

Alternate Namessupersedes, prior
24. CommunicationRequest.groupIdentifier
Definition

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.

ShortComposite request this is part of
Comments

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.

Control0..1
TypeIdentifier
Summarytrue
Alternate NamesgrouperId
26. CommunicationRequest.status
Definition

The status of the proposal or order.

Shortdraft | active | suspended | cancelled | completed | entered-in-error | unknown
Comments

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.

Control1..1
BindingThe codes SHALL be taken from RequestStatus
(required to http://hl7.org/fhir/ValueSet/request-status|3.0.2)

The status of the communication request.

Typecode
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
28. CommunicationRequest.category
Definition

The type of message to be sent such as alert, notification, reminder, instruction, etc.

ShortMessage category
Comments

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'.

Control1..*
BindingFor example codes, see CommunicationCategory
(example to http://hl7.org/fhir/ValueSet/communication-category|3.0.2)

Codes for general categories of communications such as alerts, instruction, etc.

TypeCodeableConcept
Pattern Value{
  "coding" : [{
    "system" : "http://snomed.info/sct",
    "code" : "223449006"
  }]
}
30. CommunicationRequest.priority
Definition

Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

ShortMessage urgency
Control0..1
BindingThe codes SHALL be taken from RequestPriority
(required to http://hl7.org/fhir/ValueSet/request-priority|3.0.2)

Codes indicating the relative importance of a communication request.

Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Meaning if MissingIf missing, this task should be performed with normal priority
32. CommunicationRequest.medium
Definition

A channel that was used for this communication (e.g. email, fax).

ShortA channel of communication
Control0..*
BindingFor example codes, see ParticipationMode|2016-11-11
(example to http://hl7.org/fhir/ValueSet/v3-ParticipationMode|2016-11-11)

Codes for communication mediums such as phone, fax, email, in person, etc.

TypeCodeableConcept
34. CommunicationRequest.subject
Definition

The patient or group that is the focus of this communication request.

ShortFocus of message
Control0..1
TypeReference(Patient)
Alternate Namespatient
36. CommunicationRequest.recipient
Definition

The entity (e.g. person, organization, clinical information system, device, group, or care team) which is the intended target of the communication.

ShortMessage recipient
Control0..*
TypeReference(ContactPerson)
38. CommunicationRequest.topic
Definition

The resources which were related to producing this communication request.

ShortFocal resources
Control0..*
TypeReference(Resource)
40. CommunicationRequest.context
Definition

The encounter or episode of care within which the communication request was created.

ShortEncounter or episode leading to message
Control0..1
TypeReference(Encounter, EpisodeOfCare)
Summarytrue
Alternate Namesencounter
42. CommunicationRequest.payload
Definition

Text, attachment(s), or resource(s) to be communicated to the recipient.

ShortMessage payload
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
44. CommunicationRequest.payload.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
46. CommunicationRequest.payload.extension
Definition

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.

ShortAdditional Content defined by implementations
Comments

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
48. CommunicationRequest.payload.modifierExtension
Definition

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.

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
50. CommunicationRequest.payload.content[x]
Definition

The communicated content (or for multi-part communications, one portion of the communication).

ShortMessage part content
Control1..1
TypeChoice of: string, Attachment, Reference(Resource)
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. CommunicationRequest.occurrence[x]
Definition

The time when this communication is to occur.

ShortWhen scheduled
Control0..1
TypeChoice of: dateTime, Period
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namestiming
54. CommunicationRequest.authoredOn
Definition

For draft requests, indicates the date of initial creation. For requests with other statuses, indicates the date of activation.

ShortWhen request transitioned to being actionable
Comments

Indicate the date and preferrably time when the request was sent

Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate NamescreatedOn
56. CommunicationRequest.sender
Definition

The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.

ShortMessage sender
Control0..1
TypeReference(Patient)
58. CommunicationRequest.requester
Definition

The individual who initiated the request and has responsibility for its activation.

ShortWho/what is requesting service
Control0..1
TypeBackboneElement
Summarytrue
Alternate Namesauthor
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
cmr-1: onBehalfOf can only be specified if agent is practitioner or device ((agent.resolve() is Practitioner) or (agent.resolve() is Device) or onBehalfOf.exists().not())
60. CommunicationRequest.requester.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
62. CommunicationRequest.requester.extension
Definition

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.

ShortAdditional Content defined by implementations
Comments

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
64. CommunicationRequest.requester.modifierExtension
Definition

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.

ShortExtensions that cannot be ignored
Comments

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.

Control0..*
TypeExtension
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Summarytrue
Alternate Namesextensions, user content, modifiers
66. CommunicationRequest.requester.agent
Definition

The device, practitioner, etc. who initiated the request.

ShortIndividual making the request
Control1..1
TypeReference(HealthProfessional Practitioner)
Summarytrue
68. CommunicationRequest.requester.agent.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Shortxml:id (or equivalent in JSON)
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
70. CommunicationRequest.requester.agent.extension
Definition

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.

ShortAdditional Content defined by implementations
Comments

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
SlicingThis element introduces a set of slices on CommunicationRequest.requester.agent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 72. CommunicationRequest.requester.agent.extension:practitionerRole
    Slice NamepractitionerRole
    Definition

    Optional Extension Element - found in all resources.

    ShortOptional Extensions Element
    Control0..*
    TypeExtension(PractitionerRole Reference) (Extension Type: Reference(nl-core-practitionerrole))
    Is Modifierfalse
    74. CommunicationRequest.requester.agent.reference
    Definition

    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.

    ShortLiteral reference, Relative, internal or absolute URL
    Comments

    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.

    Control0..1
    This element is affected by the following invariants: ref-1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    76. CommunicationRequest.requester.agent.identifier
    Definition

    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.

    ShortLogical reference, when literal reference is not known
    Comments

    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.

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier
    Summarytrue
    78. CommunicationRequest.requester.agent.display
    Definition

    Plain text narrative that identifies the resource in addition to the resource reference.

    ShortText alternative for the resource
    Comments

    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.

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    80. CommunicationRequest.requester.onBehalfOf
    Definition

    The organization the device or practitioner was acting on behalf of.

    ShortOrganization agent is acting for
    Control0..1
    This element is affected by the following invariants: cmr-1
    TypeReference(Organization)
    Summarytrue
    Requirements

    Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request.

    82. CommunicationRequest.reasonCode
    Definition

    Describes why the request is being made in coded or textual form.

    ShortWhy is communication needed?
    Comments

    Textual reasons can be caprued using reasonCode.text.

    Control1..1
    BindingFor example codes, see ActReason|2016-11-11
    (example to http://hl7.org/fhir/ValueSet/v3-ActReason|2016-11-11)

    Codes for describing reasons for the occurrence of a communication.

    TypeCodeableConcept
    Summarytrue
    Pattern Value{
      "coding" : [{
        "system" : "http://snomed.info/sct",
        "code" : "713603004"
      }]
    }
    84. CommunicationRequest.reasonReference
    Definition

    Indicates another resource whose existence justifies this request.

    ShortWhy is communication needed?
    Control0..*
    TypeReference(Condition, Observation)
    Summarytrue
    86. CommunicationRequest.note
    Definition

    Comments made about the request by the requester, sender, recipient, subject or other participants.

    ShortComments made about communication request
    Control0..*
    TypeAnnotation