HL7 FHIR Implementation Guide: Rwanda HIV
0.1.0 - ci-build
HL7 FHIR Implementation Guide: Rwanda HIV, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openhie/Rwanda-HIV/ and changes regularly. See the Directory of published versions
Official URL: http://moh.gov.rw/fhir/StructureDefinition/hiv-arv-treatment | Version: 0.1.0 | |||
Active as of 2024-10-11 | Computable Name: ARVTreatment |
Represents a patient’s Antiretroviral Therapy (ART) treatment record, starting from ART initiation.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
Slices for identifier | 1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:system | |
identifier:PLAC | 1..1 | Identifier | External Ids for this plan | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | |
display | 0..1 | string | Representation defined by the system Required Pattern: Placer identifier | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: Unique ART number | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.gov.rw/fhir/identifier/uan | |
value | 1..1 | string | The value that is unique | |
encounter | 1..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | |
period | 1..1 | Period | Time period plan covers | |
activity | 1..* | BackboneElement | Action to occur or has occurred as part of plan | |
plannedActivityReference | 1..1 | Reference(MedicationRequest) | Activity that is intended to be part of the care plan | |
note | S | 0..* | Annotation | Comments about the plan |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:system |
identifier:PLAC | Σ | 1..1 | Identifier | External Ids for this plan |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.gov.rw/fhir/identifier/uan |
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
intent | ?!Σ | 1..1 | code | proposal | plan | order | option | directive Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
subject | Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for |
encounter | Σ | 1..1 | Reference(Encounter) | The Encounter during which this CarePlan was created |
period | Σ | 1..1 | Period | Time period plan covers |
activity | 1..* | BackboneElement | Action to occur or has occurred as part of plan | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
plannedActivityReference | 1..1 | Reference(MedicationRequest) | Activity that is intended to be part of the care plan | |
note | S | 0..* | Annotation | Comments about the plan |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.identifier:PLAC.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:system | ||||
identifier:PLAC | Σ | 1..1 | Identifier | External Ids for this plan | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | ||||
display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Placer identifier | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Unique ART number | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.gov.rw/fhir/identifier/uan | ||||
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | RequestOrchestration | NutritionOrder) | Fulfills plan, proposal or order | ||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | order | option | directive Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | Σ | 0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for | ||||
encounter | Σ | 1..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | ||||
period | Σ | 1..1 | Period | Time period plan covers | ||||
created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
custodian | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
addresses | Σ | 0..* | CodeableReference(Condition) | Health issues this plan addresses Binding: SNOMEDCTClinicalFindings (example): Codes that describe the health issues this plan addresses. | ||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
activity | 1..* | BackboneElement | Action to occur or has occurred as part of plan | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
performedActivity | 0..* | CodeableReference(Resource) | Results of the activity (concept, or Appointment, Encounter, Procedure, etc.) Binding: CarePlanActivityPerformed (example): Identifies the results of the activity. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
plannedActivityReference | 1..1 | Reference(MedicationRequest) | Activity that is intended to be part of the care plan | |||||
note | S | 0..* | Annotation | Comments about the plan | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
CarePlan.identifier:PLAC.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
CarePlan.identifier:PLAC.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0 from the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | |
CarePlan.addresses | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | |
CarePlan.activity.performedActivity | example | CarePlanActivityPerformedhttp://hl7.org/fhir/ValueSet/care-plan-activity-performed from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
Slices for identifier | 1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:system | |
identifier:PLAC | 1..1 | Identifier | External Ids for this plan | |
type | ||||
coding | ||||
system | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
code | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | |
display | 0..1 | string | Representation defined by the system Required Pattern: Placer identifier | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: Unique ART number | |
system | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.gov.rw/fhir/identifier/uan | |
value | 1..1 | string | The value that is unique | |
encounter | 1..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | |
period | 1..1 | Period | Time period plan covers | |
activity | 1..* | BackboneElement | Action to occur or has occurred as part of plan | |
plannedActivityReference | 1..1 | Reference(MedicationRequest) | Activity that is intended to be part of the care plan | |
note | S | 0..* | Annotation | Comments about the plan |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | Σ | 1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:system |
identifier:PLAC | Σ | 1..1 | Identifier | External Ids for this plan |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.gov.rw/fhir/identifier/uan |
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. |
intent | ?!Σ | 1..1 | code | proposal | plan | order | option | directive Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
subject | Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for |
encounter | Σ | 1..1 | Reference(Encounter) | The Encounter during which this CarePlan was created |
period | Σ | 1..1 | Period | Time period plan covers |
activity | 1..* | BackboneElement | Action to occur or has occurred as part of plan | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
plannedActivityReference | 1..1 | Reference(MedicationRequest) | Activity that is intended to be part of the care plan | |
note | S | 0..* | Annotation | Comments about the plan |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.identifier:PLAC.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | Σ | 1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:system | ||||
identifier:PLAC | Σ | 1..1 | Identifier | External Ids for this plan | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: PLAC | ||||
display | ΣC | 0..1 | string | Representation defined by the system Required Pattern: Placer identifier | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Unique ART number | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: http://moh.gov.rw/fhir/identifier/uan | ||||
value | ΣC | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | RequestOrchestration | NutritionOrder) | Fulfills plan, proposal or order | ||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
intent | ?!Σ | 1..1 | code | proposal | plan | order | option | directive Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | Σ | 0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for | ||||
encounter | Σ | 1..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | ||||
period | Σ | 1..1 | Period | Time period plan covers | ||||
created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
custodian | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
addresses | Σ | 0..* | CodeableReference(Condition) | Health issues this plan addresses Binding: SNOMEDCTClinicalFindings (example): Codes that describe the health issues this plan addresses. | ||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
activity | 1..* | BackboneElement | Action to occur or has occurred as part of plan | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
performedActivity | 0..* | CodeableReference(Resource) | Results of the activity (concept, or Appointment, Encounter, Procedure, etc.) Binding: CarePlanActivityPerformed (example): Identifies the results of the activity. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
plannedActivityReference | 1..1 | Reference(MedicationRequest) | Activity that is intended to be part of the care plan | |||||
note | S | 0..* | Annotation | Comments about the plan | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
CarePlan.identifier:PLAC.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
CarePlan.identifier:PLAC.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0 from the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | |
CarePlan.addresses | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | |
CarePlan.activity.performedActivity | example | CarePlanActivityPerformedhttp://hl7.org/fhir/ValueSet/care-plan-activity-performed from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Other representations of profile: CSV, Excel, Schematron