CarePlan

The CarePlan FHIR resource is for Immunization Supplemental Data

idΣ1..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ1..1canonical(StructureDefinition)
securityΣ0..1CodingBinding
tagΣ0..1Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
containedI1..1Condition
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
id0..1string
extensionI0..*Extension
codingΣ0..1Coding
textΣ1..1string
systemΣ1..1uri
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
instantiatesCanonicalΣ0..1canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)
instantiatesUriΣ0..1uri
basedOnΣ0..1Reference(CarePlan)
replacesΣ0..1Reference(CarePlan)
partOfΣ0..1Reference(CarePlan)
id0..1string
id0..0string
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
id0..0string
extensionI0..*Extension
url1..1uriFixed Value
valueStringstring
url1..1uriFixed Value
value0..1System.String
intentΣ ?!1..1codeBinding
categoryΣ0..1CodeableConcept
titleΣ0..1string
descriptionΣ0..1string
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
encounterΣ0..1Reference(Encounter)
id0..0string
extensionI0..*Extension
startΣ I1..1dateTime
endΣ I0..1dateTime
createdΣ0..1dateTime
authorΣ0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)
contributor0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)
careTeam0..1Reference(CareTeam)
addressesΣ0..1Reference(Condition)
supportingInfo0..1Reference(Resource)
goal0..1Reference(Goal)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
outcomeCodeableConcept0..1CodeableConcept
outcomeReference0..1Reference(Resource)
progress0..1Annotation
referenceI0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
kind0..1codeBinding
instantiatesCanonical0..1canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)
instantiatesUri0..1uri
code0..1CodeableConcept
reasonCode0..1CodeableConcept
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
goal0..1Reference(Goal)
status?!1..1codeBinding
statusReason0..1CodeableConcept
doNotPerform?!0..1boolean
scheduledTimingTiming
scheduledPeriodPeriod
scheduledStringstring
id0..1string
extensionI0..*Extension
referenceΣ I1..1string
typeΣ0..0uriBinding
identifierΣ0..0Identifier
displayΣ0..0string
performer0..1Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..1string
codeΣ1..1code
displayΣ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
dailyAmount0..1SimpleQuantity
quantity0..1SimpleQuantity
description0..1string
id0..0string
extensionI0..*Extension
timeΣ0..1dateTime
textΣ1..1markdown
CarePlan
DefinitionFHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution
Cardinality0...*
AliasCare Team
Comments

resourceCarePlan contains resourceCondition for PIR Special Considerations data.

Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Request
  • rim: Act[classCode=PCPR, moodCode=INT]
CarePlan.id
DefinitionPIR internal Special Consideration Identifier
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Mappings
  • source-PIR: SPECIAL_CONSIDERATION.CONTRA_ID
  • source-PHSL: specialConsiderationId
CarePlan.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality1...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.meta.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.meta.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.meta.versionId
DefinitionThe version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.
Cardinality0...1
Typeid
SummaryTrue
Comments

Apply "2025.01.1". This indicates the FHIR Specs as of year 2025 Jan.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.meta.lastUpdated
DefinitionWhen the resource last changed - e.g. when the version changed.
Cardinality0...1
Typeinstant
SummaryTrue
Comments

Updated: Relax the previously crossed-out elements.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.meta.source
DefinitionA uri that identifies the source system of the resource. This provides a minimal amount of [Provenance](provenance.html#) information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.
Cardinality0...1
Typeuri
SummaryTrue
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.meta.profile
DefinitionA list of profiles (references to [StructureDefinition](structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](structuredefinition-definitions.html#StructureDefinition.url).
Cardinality1...1
Typecanonical(StructureDefinition)
SummaryTrue
Comments

Apply "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.meta.security
DefinitionSecurity labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
Cardinality0...1
TypeCoding
Binding

Security Labels from the Healthcare Privacy and Security Classification System.

All Security Labels (extensible)
SummaryTrue
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.meta.tag
DefinitionTags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
Cardinality0...1
TypeCoding
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

CommonTags (example)
SummaryTrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
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 information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
CarePlan.contained
DefinitionContains resourceCondition as part of PIR Special Consideration
Cardinality1...1
TypeCondition
Aliasinline resources, anonymous resources, contained resources
Comments

resourceCondition is part of PIR Special Consideration

Invariants
  • con-3: Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error and category is problem-list-item
    clinicalStatus.exists() or verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code = 'entered-in-error').exists() or category.select($this='problem-list-item').empty()
  • con-4: If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
    abatement.empty() or clinicalStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-clinical' and (code='resolved' or code='remission' or code='inactive')).exists()
  • con-5: Condition.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
    verificationStatus.coding.where(system='http://terminology.hl7.org/CodeSystem/condition-ver-status' and code='entered-in-error').empty() or clinicalStatus.empty()
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: N/A
  • rim: Entity. Role, or Act
  • workflow: Event
  • sct-concept: < 243796009 |Situation with explicit context| : 246090004 |Associated finding| = ( ( < 404684003 |Clinical finding| MINUS ( << 420134006 |Propensity to adverse reactions| OR << 473010000 |Hypersensitivity condition| OR << 79899007 |Drug interaction| OR << 69449002 |Drug action| OR << 441742003 |Evaluation finding| OR << 307824009 |Administrative status| OR << 385356007 |Tumor stage finding|)) OR < 272379006 |Event|)
  • v2: PPR message
  • rim: Observation[classCode=OBS, moodCode=EVN, code=ASSERTION, value<Diagnosis]
CarePlan.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
CarePlan.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
CarePlan.identifier
DefinitionPIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)
Cardinality1...1
TypeIdentifier
SummaryTrue
Requirements

Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.

Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.identifier
  • w5: FiveWs.identifier
  • v2: PTH-3
  • rim: .id
CarePlan.identifier.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
CarePlan.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality1...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
CarePlan.identifier.type.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.identifier.type.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.identifier.type.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality0...1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
CarePlan.identifier.type.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality1...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
  • source-PIR: "PANORAMASCID"
CarePlan.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
  • source-PIR: https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-special-consideration-id
CarePlan.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
  • source-PIR: SPECIAL_CONSIDERATION.CONTRA_ID
  • source-PHSL: specialConsiderationId
CarePlan.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
CarePlan.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
CarePlan.instantiatesCanonical
DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
Cardinality0...1
Typecanonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.instantiatesCanonical
  • rim: .outboundRelationship[typeCode=DEFN].target
CarePlan.instantiatesUri
DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.
Cardinality0...1
Typeuri
SummaryTrue
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.instantiatesUri
  • rim: .outboundRelationship[typeCode=DEFN].target
CarePlan.basedOn
DefinitionA care plan that is fulfilled in whole or in part by this care plan.
Cardinality0...1
TypeReference(CarePlan)
SummaryTrue
Aliasfulfills
Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.basedOn
CarePlan.replaces
DefinitionCompleted or terminated care plan whose function is taken by this new care plan.
Cardinality0...1
TypeReference(CarePlan)
SummaryTrue
Aliassupersedes
Requirements

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

Comments

The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.replaces
CarePlan.partOf
DefinitionA larger care plan of which this particular care plan is a component or step.
Cardinality0...1
TypeReference(CarePlan)
SummaryTrue
Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.status
DefinitionPossible status from PIR: | revoked | completed |. Revoked = deleted. Completed = active.
Cardinality1...1
Typecode
Binding

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

RequestStatus (required)
ModifierTrue
SummaryTrue
Requirements

Allows clinicians to determine whether the plan is actionable or not.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.status {uses different ValueSet}
  • w5: FiveWs.status
  • v2: PTH-5
  • rim: .statusCode planned = new active = active completed = completed
  • source-PIR-active: completed
  • source-PIR-deleted: revoked
CarePlan.status.id
Definitionunique id for the element within a resource (for internal references)
Cardinality0...1
Typestring
CarePlan.status.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
CarePlan.status.extension:_status
DefinitionOptional Extension Element - found in all resources.
Cardinality0...1
TypeExtension(Complex)
Aliasextensions, user content
Comments

To be applied when Special Consideration is deleted in PIR.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
CarePlan.status.extension:_status.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
CarePlan.status.extension:_status.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.status.extension:_status.extension:scDeleteReason
DefinitionSpecial Consideration Deleted Reason Other, specify
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list or NO delete reason provided.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR-nullReason: Other
CarePlan.status.extension:_status.extension:scDeleteReason.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
CarePlan.status.extension:_status.extension:scDeleteReason.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.status.extension:_status.extension:scDeleteReason.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

scDeleteReason

Mappings
  • rim: N/A
CarePlan.status.extension:_status.extension:scDeleteReason.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.status.extension:_status.extension:scDeleteReasonOther
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...1
TypeExtension
Aliasextensions, user content
Comments

To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list. See Mappings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • source-PIR-null: unknown
CarePlan.status.extension:_status.extension:scDeleteReasonOther.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
CarePlan.status.extension:_status.extension:scDeleteReasonOther.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.status.extension:_status.extension:scDeleteReasonOther.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

scDeleteReasonOther

Mappings
  • rim: N/A
CarePlan.status.extension:_status.extension:scDeleteReasonOther.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality1...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.status.extension:_status.url
DefinitionSource of the definition for the extension code - a logical name or a URL.
Cardinality1...1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Value

http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status

Mappings
  • rim: N/A
CarePlan.status.extension:_status.value[x]
DefinitionValue of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
Cardinality0...0
Typebase64Binary
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.status.value
DefinitionPrimitive value for code
Cardinality0...1
TypeSystem.String
CarePlan.intent
DefinitionPIR applies value | order | for FHIR purposes only.
Cardinality1...1
Typecode
Binding

Codes indicating the degree of authority/intentionality associated with a care plan.

CarePlanIntent (required)
ModifierTrue
SummaryTrue
Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Comments

Apply "order"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.intent
CarePlan.category
DefinitionIdentifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.
Cardinality0...1
TypeCodeableConcept
Binding

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

CarePlanCategory (example)
SummaryTrue
Requirements

Used for filtering what plan(s) are retrieved and displayed to different types of users.

Comments

There may be multiple axes of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.class
CarePlan.title
DefinitionHuman-friendly name for the care plan.
Cardinality0...1
Typestring
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.description
DefinitionA description of the scope and nature of the plan.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Provides more detail than conveyed by category.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.what[x]
CarePlan.subject
DefinitionIdentifies the patient or group whose intended care is described by the plan.
Cardinality1...1
TypeReference(Patient | Group)
SummaryTrue
Aliaspatient
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.subject
  • w5: FiveWs.subject[x]
  • v2: PID-3
  • rim: .participation[typeCode=PAT].role[classCode=PAT]
  • w5: FiveWs.subject
CarePlan.subject.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.subject.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.subject.reference
DefinitionA 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.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: fullURL + "Patient/" + (Patient ID)
CarePlan.subject.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.subject.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Cardinality0...1
TypeIdentifier
SummaryTrue
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.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
CarePlan.subject.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.encounter
DefinitionThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.
Cardinality0...1
TypeReference(Encounter)
SummaryTrue
Comments

This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.context
  • w5: FiveWs.context
  • v2: Associated PV1
  • rim: .
CarePlan.period
DefinitionIndicates when the plan did (or is intended to) come into effect and end.
Cardinality1...1
TypePeriod
SummaryTrue
Aliastiming
Requirements

Allows tracking what plan(s) are in effect at a particular time.

Comments

Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.occurrence[x]
  • w5: FiveWs.planned
  • v2: GOL-7 / GOL-8
  • rim: .effectiveTime
CarePlan.period.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
CarePlan.period.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.period.start
DefinitionThe start of the period. The boundary is inclusive.
Cardinality1...1
TypedateTime
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.1
  • rim: ./low
  • source-PIR: SPECIAL_CONSIDERATION.EFFECTIVE_FROM_DATE
  • source-PHSL: effectiveFrom
CarePlan.period.end
DefinitionThe end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
Cardinality0...1
TypedateTime
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: DR.2
  • rim: ./high
  • source-PIR: SPECIAL_CONSIDERATION.EFFECTIVE_TO_DATE
  • source-PHSL: effectiveTo
CarePlan.created
DefinitionRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.
Cardinality0...1
TypedateTime
SummaryTrue
AliasauthoredOn
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.authoredOn
  • w5: FiveWs.recorded
  • rim: .participation[typeCode=AUT].time
CarePlan.author
DefinitionWhen populated, the author is responsible for the care plan. The care plan is attributed to the author.
Cardinality0...1
TypeReference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)
SummaryTrue
Comments

The author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.requester
  • w5: FiveWs.author
CarePlan.contributor
DefinitionIdentifies the individual(s) or organization who provided the contents of the care plan.
Cardinality0...1
TypeReference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)
Comments

Collaborative care plans may have multiple contributors.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.careTeam
DefinitionIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan.
Cardinality0...1
TypeReference(CareTeam)
Requirements

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.performer {similar but does not entail CareTeam}
  • w5: FiveWs.actor
CarePlan.addresses
DefinitionIdentifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.
Cardinality0...1
TypeReference(Condition)
SummaryTrue
Requirements

Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns.

Comments

When the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.reasonReference
  • w5: FiveWs.why[x]
  • v2: PRB-4
  • rim: .actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]
CarePlan.supportingInfo
DefinitionIdentifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.
Cardinality0...1
TypeReference(Resource)
Requirements

Identifies barriers and other considerations associated with the care plan.

Comments

Use "concern" to identify specific conditions addressed by the care plan.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.supportingInfo
CarePlan.goal
DefinitionDescribes the intended objective(s) of carrying out the care plan.
Cardinality0...1
TypeReference(Goal)
Requirements

Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.

Comments

Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: GOL.1
  • rim: .outboundRelationship[typeCode<=OBJ].
CarePlan.activity
DefinitionIdentifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.
Cardinality1...1
TypeBackboneElement
Requirements

Allows systems to prompt for performance of planned activities, and validate plans against best practice.

Invariants
  • cpl-3: Provide a reference or detail, not both
    detail.empty() or reference.empty()
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: {no mapping NOTE: This is a list of contained Request-Event tuples!}
  • rim: .outboundRelationship[typeCode=COMP].target
CarePlan.activity.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.activity.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.activity.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
CarePlan.activity.outcomeCodeableConcept
DefinitionIdentifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).
Cardinality0...1
TypeCodeableConcept
Binding

Identifies the results of the activity.

CarePlanActivityOutcome (example)
Comments

Note that this should not duplicate the activity status (e.g. completed or in progress).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
CarePlan.activity.outcomeReference
DefinitionDetails of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).
Cardinality0...1
TypeReference(Resource)
Requirements

Links plan to resulting actions.

Comments

The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: {Event that is outcome of Request in activity.reference}
  • rim: .inboundRelationship[typeCode=FLFS].source
CarePlan.activity.progress
DefinitionNotes about the adherence/status/progress of the activity.
Cardinality0...1
TypeAnnotation
Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NTE?
  • rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
CarePlan.activity.reference
DefinitionThe details of the proposed activity represented in a specific resource.
Cardinality0...1
TypeReference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)
Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Standard extension exists (resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference.
The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed independently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: {Request that resulted in Event in activity.actionResulting}
  • rim: .outboundRelationship[typeCode=COMP].target
CarePlan.activity.detail
DefinitionA simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.
Cardinality1...1
TypeBackboneElement
Requirements

Details in a simple form for generic care plan systems.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target
CarePlan.activity.detail.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.activity.detail.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.activity.detail.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
CarePlan.activity.detail.kind
DefinitionA description of the kind of resource the in-line definition of a care plan activity is representing. The CarePlan.activity.detail is an in-line definition when a resource is not referenced using CarePlan.activity.reference. For example, a MedicationRequest, a ServiceRequest, or a CommunicationRequest.
Cardinality0...1
Typecode
Binding

Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.

CarePlanActivityKind (required)
Requirements

May determine what types of extensions are permitted.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code
CarePlan.activity.detail.instantiatesCanonical
DefinitionThe URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
Cardinality0...1
Typecanonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)
Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.instantiatesCanonical
  • rim: .outboundRelationship[typeCode=DEFN].target
CarePlan.activity.detail.instantiatesUri
DefinitionThe URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity.
Cardinality0...1
Typeuri
Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.instantiatesUri
  • rim: .outboundRelationship[typeCode=DEFN].target
CarePlan.activity.detail.code
DefinitionDetailed description of the type of planned activity; e.g. what lab test, what procedure, what kind of encounter.
Cardinality0...1
TypeCodeableConcept
Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

ProcedureCodes(SNOMEDCT) (example)
Requirements

Allows matching performed to planned as well as validation against protocols.

Comments

Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.code
  • v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
  • rim: .code
CarePlan.activity.detail.reasonCode
DefinitionProvides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.
Cardinality0...1
TypeCodeableConcept
Binding

Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.

SNOMEDCTClinicalFindings (example)
Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.reasonCode
CarePlan.activity.detail.reasonReference
DefinitionIndicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan.
Cardinality1...1
TypeReference(Condition | Observation | DiagnosticReport | DocumentReference)
Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.reasonReference
CarePlan.activity.detail.reasonReference.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.activity.detail.reasonReference.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.activity.detail.reasonReference.reference
DefinitionA 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.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-PIR: "#Condition"+ (PIR SC ID)
CarePlan.activity.detail.reasonReference.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...1
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.activity.detail.reasonReference.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Cardinality0...1
TypeIdentifier
SummaryTrue
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.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
CarePlan.activity.detail.reasonReference.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...1
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.activity.detail.goal
DefinitionInternal reference that identifies the goals that this activity is intended to contribute towards meeting.
Cardinality0...1
TypeReference(Goal)
Requirements

So that participants know the link explicitly.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .outboundRelationship[typeCode<=OBJ].
CarePlan.activity.detail.status
DefinitionPIR applies | completed | for FHIR purposes.
Cardinality1...1
Typecode
Binding

Codes that reflect the current state of a care plan activity within its overall life cycle.

CarePlanActivityStatus (required)
ModifierTrue
Requirements

Indicates progress against the plan, whether the activity is still relevant for the plan.

Comments

Apply "completed"

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.status
  • v2: ORC-5?
  • rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted
CarePlan.activity.detail.statusReason
DefinitionProvides reason why the activity isn't yet started, is on hold, was cancelled, etc.
Cardinality0...1
TypeCodeableConcept
Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.statusReason
CarePlan.activity.detail.doNotPerform
DefinitionIf true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, or missing, indicates that the described activity is one that should be engaged in when following the plan.
Cardinality0...1
Typeboolean
ModifierTrue
Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.doNotPerform
  • rim: actionNegationInd
CarePlan.activity.detail.scheduled[x]
DefinitionThe period, timing or frequency upon which the described activity is to occur.
Cardinality0...1
TypeTiming
Requirements

Allows prompting for activities and detection of missed planned activities.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.occurrence[x]
  • v2: TQ1
  • rim: .effectiveTime
CarePlan.activity.detail.location
DefinitionIdentifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.
Cardinality0...1
TypeReference(Location)
Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBR-24(???!!)
  • rim: .participation[typeCode=LOC].role
CarePlan.activity.detail.location.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.activity.detail.location.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.activity.detail.location.reference
DefinitionA 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.
Cardinality1...1
Typestring
SummaryTrue
Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
  • source-HA: "#Location/"(SDL_ID)+"org"+(BRANCH_ID)
  • source-eForm: fullURL+"Location/"+(SDL_ID)+"org"+(BRANCH_ID)
CarePlan.activity.detail.location.type
DefinitionThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
Cardinality0...0
Typeuri
Binding

Aa resource (or, for logical models, the URI of the logical model).

ResourceType (extensible)
SummaryTrue
Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.activity.detail.location.identifier
DefinitionAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
Cardinality0...0
TypeIdentifier
SummaryTrue
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.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: .identifier
CarePlan.activity.detail.location.display
DefinitionPlain text narrative that identifies the resource in addition to the resource reference.
Cardinality0...0
Typestring
SummaryTrue
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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: N/A
CarePlan.activity.detail.performer
DefinitionIdentifies who's expected to be involved in the activity.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)
Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.performer
  • v2: PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
  • rim: .participation[typeCode=PFM]
CarePlan.activity.detail.product[x]
DefinitionIdentifies the vaccine agent or antiger to apply special consideration for.
Cardinality1...1
TypeCodeableConcept
Binding

A product supplied or administered as part of a care plan activity.

SNOMEDCTMedicationCodes (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXE-2 / RXO-1 / RXD-2
  • rim: .participation[typeCode=PRD].role
CarePlan.activity.detail.product[x].id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.activity.detail.product[x].extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.activity.detail.product[x].coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
SummaryTrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
CarePlan.activity.detail.product[x].coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
CarePlan.activity.detail.product[x].coding.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.activity.detail.product[x].coding.system
Definition1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
  • code-NVC: https://nvc-cnv.canada.ca
  • code-PIR: https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code
CarePlan.activity.detail.product[x].coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
CarePlan.activity.detail.product[x].coding.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • source-PIR-code-agent: BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(sc.AGENT_CD_CNCPT_ID)
  • source-PIR-code-antigen: BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)
  • source-PHSL-agent: agent
  • source-PHSL-antigen: antigen
CarePlan.activity.detail.product[x].coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality1...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

See Mappings

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
  • source-PIR-code-agent: REPORTNG.GET_ITERM_DESC(sc.AGENT_CD_CNCPT_ID)
  • source-PIR-code-antigen: REPORTNG.GET_ITERM_DESC(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)
  • source-PHSL-agent: agentDescription
  • source-PHSL-antigen: antigenDescription
CarePlan.activity.detail.product[x].coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
CarePlan.activity.detail.product[x].text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
CarePlan.activity.detail.dailyAmount
DefinitionIdentifies the quantity expected to be consumed in a given day.
Cardinality0...1
TypeSimpleQuantity
Aliasdaily dose
Requirements

Allows rough dose checking.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-23 / RXE-19 / RXD-12
  • rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity
CarePlan.activity.detail.quantity
DefinitionIdentifies the quantity expected to be supplied, administered or consumed by the subject.
Cardinality0...1
TypeSimpleQuantity
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
  • rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity
CarePlan.activity.detail.description
DefinitionThis provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.
Cardinality0...1
Typestring
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NTE?
  • rim: .text
CarePlan.note
DefinitionComments about the special consideration
Cardinality0...*
TypeAnnotation
Requirements

Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.

Comments

Comments about the special consideration

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • workflow: Request.note
  • v2: NTE?
  • rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
CarePlan.note.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...0
Typestring
Mappings
  • rim: n/a
CarePlan.note.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
CarePlan.note.author[x]
DefinitionThe individual responsible for making the annotation.
Cardinality0...0
TypeReference(Practitioner | Patient | RelatedPerson | Organization)
SummaryTrue
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.participant[typeCode=AUT].role
CarePlan.note.time
DefinitionIndicates when this particular annotation was made.
Cardinality0...1
TypedateTime
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.effectiveTime
CarePlan.note.text
DefinitionThe text of the annotation in markdown format.
Cardinality1...1
Typemarkdown
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Act.text
<StructureDefinition xmlns="http://hl7.org/fhir">
    <meta>
        <versionId value="7" />
        <lastUpdated value="2025-01-24T22:56:35.0626075+00:00" />
    </meta>
    <url value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan" />
    <name value="CarePlan" />
    <status value="draft" />
    <date value="2022-03-04T22:33:55.2668635+00:00" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="CarePlan" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/CarePlan" />
    <derivation value="constraint" />
    <differential>
        <element id="CarePlan">
            <path value="CarePlan" />
            <short value="FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution" />
            <definition value="FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution" />
            <comment value="resourceCarePlan contains resourceCondition for PIR Special Considerations data." />
        </element>
        <element id="CarePlan.id">
            <path value="CarePlan.id" />
            <short value="PIR internal Special Consideration ID" />
            <definition value="PIR internal Special Consideration Identifier" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="SPECIAL_CONSIDERATION.CONTRA_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="specialConsiderationId" />
            </mapping>
        </element>
        <element id="CarePlan.meta">
            <path value="CarePlan.meta" />
            <min value="1" />
        </element>
        <element id="CarePlan.meta.versionId">
            <path value="CarePlan.meta.versionId" />
            <comment value="Apply &quot;2025.01.1&quot;.  This indicates the FHIR Specs as of year 2025 Jan." />
        </element>
        <element id="CarePlan.meta.lastUpdated">
            <path value="CarePlan.meta.lastUpdated" />
            <comment value="Updated: Relax the previously crossed-out elements." />
        </element>
        <element id="CarePlan.meta.profile">
            <path value="CarePlan.meta.profile" />
            <comment value="Apply &quot;http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan&quot;" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="CarePlan.meta.security">
            <path value="CarePlan.meta.security" />
            <max value="1" />
        </element>
        <element id="CarePlan.meta.tag">
            <path value="CarePlan.meta.tag" />
            <max value="1" />
        </element>
        <element id="CarePlan.contained">
            <path value="CarePlan.contained" />
            <short value="Contains resourceCondition as part of PIR Special Consideration" />
            <definition value="Contains resourceCondition as part of PIR Special Consideration" />
            <comment value="resourceCondition is part of PIR Special Consideration" />
            <min value="1" />
            <max value="1" />
            <type>
                <code value="Resource" />
                <profile value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Condition" />
            </type>
        </element>
        <element id="CarePlan.identifier">
            <path value="CarePlan.identifier" />
            <short value="PIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)" />
            <definition value="PIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="CarePlan.identifier.type">
            <path value="CarePlan.identifier.type" />
            <min value="1" />
        </element>
        <element id="CarePlan.identifier.type.coding">
            <path value="CarePlan.identifier.type.coding" />
            <max value="1" />
        </element>
        <element id="CarePlan.identifier.type.text">
            <path value="CarePlan.identifier.type.text" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="&quot;PANORAMASCID&quot;" />
            </mapping>
        </element>
        <element id="CarePlan.identifier.system">
            <path value="CarePlan.identifier.system" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-special-consideration-id" />
            </mapping>
        </element>
        <element id="CarePlan.identifier.value">
            <path value="CarePlan.identifier.value" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="SPECIAL_CONSIDERATION.CONTRA_ID" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="specialConsiderationId" />
            </mapping>
        </element>
        <element id="CarePlan.instantiatesCanonical">
            <path value="CarePlan.instantiatesCanonical" />
            <max value="1" />
        </element>
        <element id="CarePlan.instantiatesUri">
            <path value="CarePlan.instantiatesUri" />
            <max value="1" />
        </element>
        <element id="CarePlan.basedOn">
            <path value="CarePlan.basedOn" />
            <max value="1" />
        </element>
        <element id="CarePlan.replaces">
            <path value="CarePlan.replaces" />
            <max value="1" />
        </element>
        <element id="CarePlan.partOf">
            <path value="CarePlan.partOf" />
            <max value="1" />
        </element>
        <element id="CarePlan.status">
            <path value="CarePlan.status" />
            <short value="Possible status from PIR: | revoked | completed |" />
            <definition value="Possible status from PIR: | revoked | completed |.  Revoked = deleted. Completed = active." />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR-active" />
                <map value="completed" />
            </mapping>
            <mapping>
                <identity value="source-PIR-deleted" />
                <map value="revoked" />
            </mapping>
        </element>
        <element id="CarePlan.status.extension:_status">
            <path value="CarePlan.status.extension" />
            <sliceName value="_status" />
            <comment value="To be applied when Special Consideration is deleted in PIR." />
            <max value="1" />
            <type>
                <code value="Extension" />
                <profile value="http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="CarePlan.status.extension:_status.extension:scDeleteReason">
            <path value="CarePlan.status.extension.extension" />
            <sliceName value="scDeleteReason" />
            <comment value="To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list or NO delete reason provided." />
            <mapping>
                <identity value="source-PIR-nullReason" />
                <map value="Other" />
            </mapping>
        </element>
        <element id="CarePlan.status.extension:_status.extension:scDeleteReasonOther">
            <path value="CarePlan.status.extension.extension" />
            <sliceName value="scDeleteReasonOther" />
            <comment value="To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list.  See Mappings." />
            <mapping>
                <identity value="source-PIR-null" />
                <map value="unknown" />
            </mapping>
        </element>
        <element id="CarePlan.intent">
            <path value="CarePlan.intent" />
            <short value="PIR applies value  | order |  for FHIR purposes only." />
            <definition value="PIR applies value  | order |  for FHIR purposes only." />
            <comment value="Apply &quot;order&quot;" />
        </element>
        <element id="CarePlan.category">
            <path value="CarePlan.category" />
            <max value="1" />
        </element>
        <element id="CarePlan.subject.reference">
            <path value="CarePlan.subject.reference" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="fullURL + &quot;Patient/&quot; + (Patient ID)" />
            </mapping>
        </element>
        <element id="CarePlan.period">
            <path value="CarePlan.period" />
            <min value="1" />
        </element>
        <element id="CarePlan.period.id">
            <path value="CarePlan.period.id" />
            <max value="0" />
        </element>
        <element id="CarePlan.period.start">
            <path value="CarePlan.period.start" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="SPECIAL_CONSIDERATION.EFFECTIVE_FROM_DATE" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="effectiveFrom" />
            </mapping>
        </element>
        <element id="CarePlan.period.end">
            <path value="CarePlan.period.end" />
            <comment value="See Mappings" />
            <mapping>
                <identity value="source-PIR" />
                <map value="SPECIAL_CONSIDERATION.EFFECTIVE_TO_DATE" />
            </mapping>
            <mapping>
                <identity value="source-PHSL" />
                <map value="effectiveTo" />
            </mapping>
        </element>
        <element id="CarePlan.contributor">
            <path value="CarePlan.contributor" />
            <max value="1" />
        </element>
        <element id="CarePlan.careTeam">
            <path value="CarePlan.careTeam" />
            <max value="1" />
        </element>
        <element id="CarePlan.addresses">
            <path value="CarePlan.addresses" />
            <max value="1" />
        </element>
        <element id="CarePlan.supportingInfo">
            <path value="CarePlan.supportingInfo" />
            <max value="1" />
        </element>
        <element id="CarePlan.goal">
            <path value="CarePlan.goal" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity">
            <path value="CarePlan.activity" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.outcomeCodeableConcept">
            <path value="CarePlan.activity.outcomeCodeableConcept" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.outcomeReference">
            <path value="CarePlan.activity.outcomeReference" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.progress">
            <path value="CarePlan.activity.progress" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail">
            <path value="CarePlan.activity.detail" />
            <min value="1" />
        </element>
        <element id="CarePlan.activity.detail.instantiatesCanonical">
            <path value="CarePlan.activity.detail.instantiatesCanonical" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.instantiatesUri">
            <path value="CarePlan.activity.detail.instantiatesUri" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.reasonCode">
            <path value="CarePlan.activity.detail.reasonCode" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.reasonReference">
            <path value="CarePlan.activity.detail.reasonReference" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.reasonReference.reference">
            <path value="CarePlan.activity.detail.reasonReference.reference" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR" />
                <map value="&quot;#Condition&quot;+ (PIR SC ID)" />
            </mapping>
        </element>
        <element id="CarePlan.activity.detail.goal">
            <path value="CarePlan.activity.detail.goal" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.status">
            <path value="CarePlan.activity.detail.status" />
            <short value="PIR applies | completed | for FHIR purposes." />
            <definition value="PIR applies | completed | for FHIR purposes." />
            <comment value="Apply &quot;completed&quot;" />
        </element>
        <element id="CarePlan.activity.detail.location.reference">
            <path value="CarePlan.activity.detail.location.reference" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-HA" />
                <map value="&quot;#Location/&quot;(SDL_ID)+&quot;org&quot;+(BRANCH_ID)" />
            </mapping>
            <mapping>
                <identity value="source-eForm" />
                <map value="fullURL+&quot;Location/&quot;+(SDL_ID)+&quot;org&quot;+(BRANCH_ID)" />
                <comment value="http://ehealth.bc.ca/eform/fhir" />
            </mapping>
        </element>
        <element id="CarePlan.activity.detail.location.type">
            <path value="CarePlan.activity.detail.location.type" />
            <max value="0" />
        </element>
        <element id="CarePlan.activity.detail.location.identifier">
            <path value="CarePlan.activity.detail.location.identifier" />
            <max value="0" />
        </element>
        <element id="CarePlan.activity.detail.location.display">
            <path value="CarePlan.activity.detail.location.display" />
            <max value="0" />
        </element>
        <element id="CarePlan.activity.detail.performer">
            <path value="CarePlan.activity.detail.performer" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.product[x]">
            <path value="CarePlan.activity.detail.product[x]" />
            <short value="The agent/antigen to be applied for special consideration." />
            <definition value="Identifies the vaccine agent or antiger to apply special consideration for." />
            <min value="1" />
            <type>
                <code value="CodeableConcept" />
            </type>
        </element>
        <element id="CarePlan.activity.detail.product[x].coding">
            <path value="CarePlan.activity.detail.product[x].coding" />
            <comment value="1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code" />
            <min value="1" />
            <max value="1" />
        </element>
        <element id="CarePlan.activity.detail.product[x].coding.system">
            <path value="CarePlan.activity.detail.product[x].coding.system" />
            <short value="1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code" />
            <definition value="1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="code-NVC" />
                <map value="https://nvc-cnv.canada.ca" />
            </mapping>
            <mapping>
                <identity value="code-PIR" />
                <map value="https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code" />
            </mapping>
        </element>
        <element id="CarePlan.activity.detail.product[x].coding.code">
            <path value="CarePlan.activity.detail.product[x].coding.code" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-code-agent" />
                <map value="BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(sc.AGENT_CD_CNCPT_ID)" />
            </mapping>
            <mapping>
                <identity value="source-PIR-code-antigen" />
                <map value="BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-agent" />
                <map value="agent" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-antigen" />
                <map value="antigen" />
            </mapping>
        </element>
        <element id="CarePlan.activity.detail.product[x].coding.display">
            <path value="CarePlan.activity.detail.product[x].coding.display" />
            <comment value="See Mappings" />
            <min value="1" />
            <mapping>
                <identity value="source-PIR-code-agent" />
                <map value="REPORTNG.GET_ITERM_DESC(sc.AGENT_CD_CNCPT_ID)" />
            </mapping>
            <mapping>
                <identity value="source-PIR-code-antigen" />
                <map value="REPORTNG.GET_ITERM_DESC(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-agent" />
                <map value="agentDescription" />
            </mapping>
            <mapping>
                <identity value="source-PHSL-antigen" />
                <map value="antigenDescription" />
            </mapping>
        </element>
        <element id="CarePlan.note">
            <path value="CarePlan.note" />
            <short value="Comments about the special consideration" />
            <definition value="Comments about the special consideration" />
            <comment value="Comments about the special consideration" />
        </element>
        <element id="CarePlan.note.id">
            <path value="CarePlan.note.id" />
            <max value="0" />
        </element>
        <element id="CarePlan.note.author[x]">
            <path value="CarePlan.note.author[x]" />
            <max value="0" />
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "meta": {
        "versionId": "7",
        "lastUpdated": "01/24/2025 22:56:35"
    },
    "url": "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan",
    "name": "CarePlan",
    "status": "draft",
    "date": "03/04/2022 22:33:55",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "CarePlan",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CarePlan",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "CarePlan",
                "path": "CarePlan",
                "short": "FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution",
                "definition": "FHIR resource applies for PIR Special Considerations - Contraindication, Exemption, Precaution",
                "comment": "resourceCarePlan contains resourceCondition for PIR Special Considerations data."
            },
            {
                "id": "CarePlan.id",
                "path": "CarePlan.id",
                "short": "PIR internal Special Consideration ID",
                "definition": "PIR internal Special Consideration Identifier",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "SPECIAL_CONSIDERATION.CONTRA_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "specialConsiderationId"
                    }
                ]
            },
            {
                "id": "CarePlan.meta",
                "path": "CarePlan.meta",
                "min": 1
            },
            {
                "id": "CarePlan.meta.versionId",
                "path": "CarePlan.meta.versionId",
                "comment": "Apply \"2025.01.1\".  This indicates the FHIR Specs as of year 2025 Jan."
            },
            {
                "id": "CarePlan.meta.lastUpdated",
                "path": "CarePlan.meta.lastUpdated",
                "comment": "Updated: Relax the previously crossed-out elements."
            },
            {
                "id": "CarePlan.meta.profile",
                "path": "CarePlan.meta.profile",
                "comment": "Apply \"http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/CarePlan\"",
                "min": 1,
                "max": "1"
            },
            {
                "id": "CarePlan.meta.security",
                "path": "CarePlan.meta.security",
                "max": "1"
            },
            {
                "id": "CarePlan.meta.tag",
                "path": "CarePlan.meta.tag",
                "max": "1"
            },
            {
                "id": "CarePlan.contained",
                "path": "CarePlan.contained",
                "short": "Contains resourceCondition as part of PIR Special Consideration",
                "definition": "Contains resourceCondition as part of PIR Special Consideration",
                "comment": "resourceCondition is part of PIR Special Consideration",
                "min": 1,
                "max": "1",
                "type":  [
                    {
                        "code": "Resource",
                        "profile":  [
                            "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/Condition"
                        ]
                    }
                ]
            },
            {
                "id": "CarePlan.identifier",
                "path": "CarePlan.identifier",
                "short": "PIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)",
                "definition": "PIR internal Special Consideration Identifier + External Special Consideration ID from source system(s)",
                "min": 1,
                "max": "1"
            },
            {
                "id": "CarePlan.identifier.type",
                "path": "CarePlan.identifier.type",
                "min": 1
            },
            {
                "id": "CarePlan.identifier.type.coding",
                "path": "CarePlan.identifier.type.coding",
                "max": "1"
            },
            {
                "id": "CarePlan.identifier.type.text",
                "path": "CarePlan.identifier.type.text",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "\"PANORAMASCID\""
                    }
                ]
            },
            {
                "id": "CarePlan.identifier.system",
                "path": "CarePlan.identifier.system",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "https://health.gov.bc.ca/fhir/NamingSystem/ca-bc-panorama-immunization-special-consideration-id"
                    }
                ]
            },
            {
                "id": "CarePlan.identifier.value",
                "path": "CarePlan.identifier.value",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "SPECIAL_CONSIDERATION.CONTRA_ID"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "specialConsiderationId"
                    }
                ]
            },
            {
                "id": "CarePlan.instantiatesCanonical",
                "path": "CarePlan.instantiatesCanonical",
                "max": "1"
            },
            {
                "id": "CarePlan.instantiatesUri",
                "path": "CarePlan.instantiatesUri",
                "max": "1"
            },
            {
                "id": "CarePlan.basedOn",
                "path": "CarePlan.basedOn",
                "max": "1"
            },
            {
                "id": "CarePlan.replaces",
                "path": "CarePlan.replaces",
                "max": "1"
            },
            {
                "id": "CarePlan.partOf",
                "path": "CarePlan.partOf",
                "max": "1"
            },
            {
                "id": "CarePlan.status",
                "path": "CarePlan.status",
                "short": "Possible status from PIR: | revoked | completed |",
                "definition": "Possible status from PIR: | revoked | completed |.  Revoked = deleted. Completed = active.",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR-active",
                        "map": "completed"
                    },
                    {
                        "identity": "source-PIR-deleted",
                        "map": "revoked"
                    }
                ]
            },
            {
                "id": "CarePlan.status.extension:_status",
                "path": "CarePlan.status.extension",
                "sliceName": "_status",
                "comment": "To be applied when Special Consideration is deleted in PIR.",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealth.bc.ca/fhir/StructureDefinition/bc-bcyimmunizationdistribution/specialCond-status"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "CarePlan.status.extension:_status.extension:scDeleteReason",
                "path": "CarePlan.status.extension.extension",
                "sliceName": "scDeleteReason",
                "comment": "To be applied when Special Consideration has been deleted in PIR with reason found in PIR drop-down list or NO delete reason provided.",
                "mapping":  [
                    {
                        "identity": "source-PIR-nullReason",
                        "map": "Other"
                    }
                ]
            },
            {
                "id": "CarePlan.status.extension:_status.extension:scDeleteReasonOther",
                "path": "CarePlan.status.extension.extension",
                "sliceName": "scDeleteReasonOther",
                "comment": "To be applied when Special Consideration has been deleted in PIR with reason not found in PIR drop-down list.  See Mappings.",
                "mapping":  [
                    {
                        "identity": "source-PIR-null",
                        "map": "unknown"
                    }
                ]
            },
            {
                "id": "CarePlan.intent",
                "path": "CarePlan.intent",
                "short": "PIR applies value  | order |  for FHIR purposes only.",
                "definition": "PIR applies value  | order |  for FHIR purposes only.",
                "comment": "Apply \"order\""
            },
            {
                "id": "CarePlan.category",
                "path": "CarePlan.category",
                "max": "1"
            },
            {
                "id": "CarePlan.subject.reference",
                "path": "CarePlan.subject.reference",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "fullURL + \"Patient/\" + (Patient ID)"
                    }
                ]
            },
            {
                "id": "CarePlan.period",
                "path": "CarePlan.period",
                "min": 1
            },
            {
                "id": "CarePlan.period.id",
                "path": "CarePlan.period.id",
                "max": "0"
            },
            {
                "id": "CarePlan.period.start",
                "path": "CarePlan.period.start",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "SPECIAL_CONSIDERATION.EFFECTIVE_FROM_DATE"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "effectiveFrom"
                    }
                ]
            },
            {
                "id": "CarePlan.period.end",
                "path": "CarePlan.period.end",
                "comment": "See Mappings",
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "SPECIAL_CONSIDERATION.EFFECTIVE_TO_DATE"
                    },
                    {
                        "identity": "source-PHSL",
                        "map": "effectiveTo"
                    }
                ]
            },
            {
                "id": "CarePlan.contributor",
                "path": "CarePlan.contributor",
                "max": "1"
            },
            {
                "id": "CarePlan.careTeam",
                "path": "CarePlan.careTeam",
                "max": "1"
            },
            {
                "id": "CarePlan.addresses",
                "path": "CarePlan.addresses",
                "max": "1"
            },
            {
                "id": "CarePlan.supportingInfo",
                "path": "CarePlan.supportingInfo",
                "max": "1"
            },
            {
                "id": "CarePlan.goal",
                "path": "CarePlan.goal",
                "max": "1"
            },
            {
                "id": "CarePlan.activity",
                "path": "CarePlan.activity",
                "min": 1,
                "max": "1"
            },
            {
                "id": "CarePlan.activity.outcomeCodeableConcept",
                "path": "CarePlan.activity.outcomeCodeableConcept",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.outcomeReference",
                "path": "CarePlan.activity.outcomeReference",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.progress",
                "path": "CarePlan.activity.progress",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail",
                "path": "CarePlan.activity.detail",
                "min": 1
            },
            {
                "id": "CarePlan.activity.detail.instantiatesCanonical",
                "path": "CarePlan.activity.detail.instantiatesCanonical",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.instantiatesUri",
                "path": "CarePlan.activity.detail.instantiatesUri",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.reasonCode",
                "path": "CarePlan.activity.detail.reasonCode",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.reasonReference",
                "path": "CarePlan.activity.detail.reasonReference",
                "min": 1,
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.reasonReference.reference",
                "path": "CarePlan.activity.detail.reasonReference.reference",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR",
                        "map": "\"#Condition\"+ (PIR SC ID)"
                    }
                ]
            },
            {
                "id": "CarePlan.activity.detail.goal",
                "path": "CarePlan.activity.detail.goal",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.status",
                "path": "CarePlan.activity.detail.status",
                "short": "PIR applies | completed | for FHIR purposes.",
                "definition": "PIR applies | completed | for FHIR purposes.",
                "comment": "Apply \"completed\""
            },
            {
                "id": "CarePlan.activity.detail.location.reference",
                "path": "CarePlan.activity.detail.location.reference",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-HA",
                        "map": "\"#Location/\"(SDL_ID)+\"org\"+(BRANCH_ID)"
                    },
                    {
                        "identity": "source-eForm",
                        "map": "fullURL+\"Location/\"+(SDL_ID)+\"org\"+(BRANCH_ID)",
                        "comment": "http://ehealth.bc.ca/eform/fhir"
                    }
                ]
            },
            {
                "id": "CarePlan.activity.detail.location.type",
                "path": "CarePlan.activity.detail.location.type",
                "max": "0"
            },
            {
                "id": "CarePlan.activity.detail.location.identifier",
                "path": "CarePlan.activity.detail.location.identifier",
                "max": "0"
            },
            {
                "id": "CarePlan.activity.detail.location.display",
                "path": "CarePlan.activity.detail.location.display",
                "max": "0"
            },
            {
                "id": "CarePlan.activity.detail.performer",
                "path": "CarePlan.activity.detail.performer",
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.product[x]",
                "path": "CarePlan.activity.detail.product[x]",
                "short": "The agent/antigen to be applied for special consideration.",
                "definition": "Identifies the vaccine agent or antiger to apply special consideration for.",
                "min": 1,
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ]
            },
            {
                "id": "CarePlan.activity.detail.product[x].coding",
                "path": "CarePlan.activity.detail.product[x].coding",
                "comment": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
                "min": 1,
                "max": "1"
            },
            {
                "id": "CarePlan.activity.detail.product[x].coding.system",
                "path": "CarePlan.activity.detail.product[x].coding.system",
                "short": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
                "definition": "1st instance Agent/Antigen in NVC code, 2nd instance Agent/Antigen in PIR code",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "code-NVC",
                        "map": "https://nvc-cnv.canada.ca"
                    },
                    {
                        "identity": "code-PIR",
                        "map": "https://fhir.infoway-inforoute.ca/NamingSystem/ca-bc-panorama-code"
                    }
                ]
            },
            {
                "id": "CarePlan.activity.detail.product[x].coding.code",
                "path": "CarePlan.activity.detail.product[x].coding.code",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-code-agent",
                        "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(sc.AGENT_CD_CNCPT_ID)"
                    },
                    {
                        "identity": "source-PIR-code-antigen",
                        "map": "BCYREPORTNG.RBCY_FN_GET_CONCEPT_CODE(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)"
                    },
                    {
                        "identity": "source-PHSL-agent",
                        "map": "agent"
                    },
                    {
                        "identity": "source-PHSL-antigen",
                        "map": "antigen"
                    }
                ]
            },
            {
                "id": "CarePlan.activity.detail.product[x].coding.display",
                "path": "CarePlan.activity.detail.product[x].coding.display",
                "comment": "See Mappings",
                "min": 1,
                "mapping":  [
                    {
                        "identity": "source-PIR-code-agent",
                        "map": "REPORTNG.GET_ITERM_DESC(sc.AGENT_CD_CNCPT_ID)"
                    },
                    {
                        "identity": "source-PIR-code-antigen",
                        "map": "REPORTNG.GET_ITERM_DESC(SPECIAL_CONSIDERATION.ASIIS_VACC_CODE)"
                    },
                    {
                        "identity": "source-PHSL-agent",
                        "map": "agentDescription"
                    },
                    {
                        "identity": "source-PHSL-antigen",
                        "map": "antigenDescription"
                    }
                ]
            },
            {
                "id": "CarePlan.note",
                "path": "CarePlan.note",
                "short": "Comments about the special consideration",
                "definition": "Comments about the special consideration",
                "comment": "Comments about the special consideration"
            },
            {
                "id": "CarePlan.note.id",
                "path": "CarePlan.note.id",
                "max": "0"
            },
            {
                "id": "CarePlan.note.author[x]",
                "path": "CarePlan.note.author[x]",
                "max": "0"
            }
        ]
    }
}