HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
0.1.0 - STU1
HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1
0.1.0 - STU1
HL7 FHIR Implementation Guide: Example IG Release 1 - US Realm | STU1, 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/Training-Solution-1 and changes regularly. See the Directory of published versions
| Official URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-arv-treatment | Version: 0.1.0 | |||
| Active as of 2024-01-27 | Computable Name: ARVTreatment | |||
This profile is to record prescribed ARV regimen against a given therapeutic line.
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 | |
  encounter | 1..1 | Reference(Encounter) | Encounter created as part of | |
| period | 1..1 | Period | Time period plan covers | |
 activity | 1..* | BackboneElement | Action to occur as part of plan | |
 outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity Binding: ARV treatment outcomes (required) |
 text | 0..1 | string | Plain text representation of the concept Required Pattern: Interruptions in treatment | |
 detail | S | 0..1 | BackboneElement | In-line definition of activity |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 artRegimenSwitchedOrSubstituted | S | 0..1 | CodeableConcept | ART Regimen Switched Or Substituted URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted Binding: ART Regimen Change Types (required) |
| artRegimenLine | S | 0..1 | CodeableConcept | ART Regimen Line URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line Binding: ART Regimen Lines (required) |
| next-visit | S | 0..1 | dateTime | Next Appointment Date URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit |
| kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Required Pattern: MedicationRequest |
| code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ARV Treatment Medication Request (required) |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: ARV medication request | |
 Slices for scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur Slice: Unordered, Open by type:$this | |
 scheduled[x]:scheduledPeriod | S | 0..1 | Period | When activity is to occur |
| Slices for product[x] | 0..1 | CodeableConcept, Reference(Medication | Substance) | What is to be administered/supplied Slice: Unordered, Open by type:$this | |
 product[x]:productCodeableConcept | S | 0..1 | CodeableConcept | What is to be administered/supplied Binding: A list of ARV regimen (required) |
 text | 0..1 | string | Plain text representation of the concept Required Pattern: ARV Regimen | |
| note | S | 0..* | Annotation | Comments about the plan |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.activity.outcomeCodeableConcept | required | VSCarePlanActivityOutcomehttp://openhie.org/fhir/training-solution-1/ValueSet/vs-careplan-outcomefrom this IG | |
| CarePlan.activity.detail.code | required | VSARVMedicationRequesthttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arvtreatment-activity-typefrom this IG | |
| CarePlan.activity.detail.product[x]:productCodeableConcept | required | VSARVRegimenhttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arv-regimenfrom this IG |
| 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 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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 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) | Encounter created as part of |
 period | Σ | 1..1 | Period | Time period plan covers |
| activity | C | 1..* | BackboneElement | Action to occur as part of plan |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity Binding: ARV treatment outcomes (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Interruptions in treatment |
| detail | SC | 0..1 | BackboneElement | In-line definition of activity |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| artRegimenSwitchedOrSubstituted | S | 0..1 | CodeableConcept | ART Regimen Switched Or Substituted URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted Binding: ART Regimen Change Types (required) |
| artRegimenLine | S | 0..1 | CodeableConcept | ART Regimen Line URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line Binding: ART Regimen Lines (required) |
| next-visit | S | 0..1 | dateTime | Next Appointment Date URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. Required Pattern: MedicationRequest |
| code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ARV Treatment Medication Request (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV medication request |
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
| Slices for scheduled[x] | 0..1 | When activity is to occur Slice: Unordered, Open by type:$this | ||
 scheduledTiming | Timing | |||
| scheduledPeriod | Period | |||
| scheduledString | string | |||
| scheduled[x]:scheduledPeriod | S | 0..1 | Period | When activity is to occur |
| Slices for product[x] | 0..1 | What is to be administered/supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||
| productCodeableConcept | CodeableConcept | |||
| productReference | Reference(Medication | Substance) | |||
| product[x]:productCodeableConcept | S | 0..1 | CodeableConcept | What is to be administered/supplied Binding: A list of ARV regimen (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV Regimen |
| note | S | 0..* | Annotation | Comments about the plan |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | |
| CarePlan.activity.outcomeCodeableConcept | required | VSCarePlanActivityOutcomehttp://openhie.org/fhir/training-solution-1/ValueSet/vs-careplan-outcomefrom this IG | |
| CarePlan.activity.detail.kind | required | Pattern: MedicationRequesthttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | |
| CarePlan.activity.detail.code | required | VSARVMedicationRequesthttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arvtreatment-activity-typefrom this IG | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | |
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| CarePlan.activity.detail.product[x]:productCodeableConcept | required | VSARVRegimenhttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arv-regimenfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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: CommonLanguages (preferred): 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 | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
| 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) | Fulfills CarePlan | ||||
| 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 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) | Encounter created as part of | ||||
| period | Σ | 1..1 | Period | Time period plan covers | ||||
| created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author | Σ | 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..* | Reference(Condition) | Health issues this plan addresses | ||||
| supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
| activity | C | 1..* | BackboneElement | Action to occur 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 | ||||
| outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity Binding: ARV treatment outcomes (required) | ||||
| id | 0..1 | string | 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 | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Interruptions in treatment | ||||
| outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
| progress | 0..* | Annotation | Comments about the activity status/progress | |||||
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail | SC | 0..1 | BackboneElement | In-line definition of activity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| artRegimenSwitchedOrSubstituted | S | 0..1 | CodeableConcept | ART Regimen Switched Or Substituted URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted Binding: ART Regimen Change Types (required) | ||||
| artRegimenLine | S | 0..1 | CodeableConcept | ART Regimen Line URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line Binding: ART Regimen Lines (required) | ||||
| next-visit | S | 0..1 | dateTime | Next Appointment Date URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. Required Pattern: MedicationRequest | ||||
| instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
| code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ARV Treatment Medication Request (required) | ||||
| id | 0..1 | string | 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 | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV medication request | ||||
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): 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. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
| statusReason | 0..1 | CodeableConcept | Reason for current status | |||||
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
| Slices for scheduled[x] | 0..1 | When activity is to occur Slice: Unordered, Open by type:$this | ||||||
| scheduledTiming | Timing | |||||||
| scheduledPeriod | Period | |||||||
| scheduledString | string | |||||||
| scheduled[x]:scheduledPeriod | S | 0..1 | Period | When activity is to occur | ||||
| location | 0..1 | Reference(Location) | Where it should happen | |||||
| performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
| Slices for product[x] | 0..1 | What is to be administered/supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept | CodeableConcept | |||||||
| productReference | Reference(Medication | Substance) | |||||||
| product[x]:productCodeableConcept | S | 0..1 | CodeableConcept | What is to be administered/supplied Binding: A list of ARV regimen (required) | ||||
 id | 0..1 | string | 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 | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV Regimen | ||||
| dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
| quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
| description | 0..1 | string | Extra info describing activity to perform | |||||
| note | S | 0..* | Annotation | Comments about the plan | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | ||||
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | required | VSCarePlanActivityOutcomehttp://openhie.org/fhir/training-solution-1/ValueSet/vs-careplan-outcomefrom this IG | ||||
| CarePlan.activity.detail.kind | required | Pattern: MedicationRequesthttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.code | required | VSARVMedicationRequesthttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arvtreatment-activity-typefrom this IG | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| CarePlan.activity.detail.product[x]:productCodeableConcept | required | VSARVRegimenhttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arv-regimenfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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() |
This structure is derived from CarePlan
Summary
Mandatory: 3 elements
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
| encounter | 1..1 | Reference(Encounter) | Encounter created as part of | |
| period | 1..1 | Period | Time period plan covers | |
| activity | 1..* | BackboneElement | Action to occur as part of plan | |
| outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity Binding: ARV treatment outcomes (required) |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: Interruptions in treatment | |
| detail | S | 0..1 | BackboneElement | In-line definition of activity |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| artRegimenSwitchedOrSubstituted | S | 0..1 | CodeableConcept | ART Regimen Switched Or Substituted URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted Binding: ART Regimen Change Types (required) |
| artRegimenLine | S | 0..1 | CodeableConcept | ART Regimen Line URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line Binding: ART Regimen Lines (required) |
| next-visit | S | 0..1 | dateTime | Next Appointment Date URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit |
| kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Required Pattern: MedicationRequest |
| code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ARV Treatment Medication Request (required) |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: ARV medication request | |
| Slices for scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur Slice: Unordered, Open by type:$this | |
| scheduled[x]:scheduledPeriod | S | 0..1 | Period | When activity is to occur |
| Slices for product[x] | 0..1 | CodeableConcept, Reference(Medication | Substance) | What is to be administered/supplied Slice: Unordered, Open by type:$this | |
| product[x]:productCodeableConcept | S | 0..1 | CodeableConcept | What is to be administered/supplied Binding: A list of ARV regimen (required) |
| text | 0..1 | string | Plain text representation of the concept Required Pattern: ARV Regimen | |
| note | S | 0..* | Annotation | Comments about the plan |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| CarePlan.activity.outcomeCodeableConcept | required | VSCarePlanActivityOutcomehttp://openhie.org/fhir/training-solution-1/ValueSet/vs-careplan-outcomefrom this IG | |
| CarePlan.activity.detail.code | required | VSARVMedicationRequesthttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arvtreatment-activity-typefrom this IG | |
| CarePlan.activity.detail.product[x]:productCodeableConcept | required | VSARVRegimenhttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arv-regimenfrom this IG |
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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| 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 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) | Encounter created as part of |
| period | Σ | 1..1 | Period | Time period plan covers |
| activity | C | 1..* | BackboneElement | Action to occur as part of plan |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity Binding: ARV treatment outcomes (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Interruptions in treatment |
| detail | SC | 0..1 | BackboneElement | In-line definition of activity |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| artRegimenSwitchedOrSubstituted | S | 0..1 | CodeableConcept | ART Regimen Switched Or Substituted URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted Binding: ART Regimen Change Types (required) |
| artRegimenLine | S | 0..1 | CodeableConcept | ART Regimen Line URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line Binding: ART Regimen Lines (required) |
| next-visit | S | 0..1 | dateTime | Next Appointment Date URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. Required Pattern: MedicationRequest |
| code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ARV Treatment Medication Request (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV medication request |
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. |
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action |
| Slices for scheduled[x] | 0..1 | When activity is to occur Slice: Unordered, Open by type:$this | ||
| scheduledTiming | Timing | |||
| scheduledPeriod | Period | |||
| scheduledString | string | |||
| scheduled[x]:scheduledPeriod | S | 0..1 | Period | When activity is to occur |
| Slices for product[x] | 0..1 | What is to be administered/supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||
| productCodeableConcept | CodeableConcept | |||
| productReference | Reference(Medication | Substance) | |||
| product[x]:productCodeableConcept | S | 0..1 | CodeableConcept | What is to be administered/supplied Binding: A list of ARV regimen (required) |
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV Regimen |
| note | S | 0..* | Annotation | Comments about the plan |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | |
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | |
| CarePlan.activity.outcomeCodeableConcept | required | VSCarePlanActivityOutcomehttp://openhie.org/fhir/training-solution-1/ValueSet/vs-careplan-outcomefrom this IG | |
| CarePlan.activity.detail.kind | required | Pattern: MedicationRequesthttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | |
| CarePlan.activity.detail.code | required | VSARVMedicationRequesthttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arvtreatment-activity-typefrom this IG | |
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | |
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | |
| CarePlan.activity.detail.product[x]:productCodeableConcept | required | VSARVRegimenhttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arv-regimenfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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: CommonLanguages (preferred): 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 | ||||
| identifier | Σ | 0..* | Identifier | External Ids for this plan | ||||
| 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) | Fulfills CarePlan | ||||
| 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 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) | Encounter created as part of | ||||
| period | Σ | 1..1 | Period | Time period plan covers | ||||
| created | Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author | Σ | 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..* | Reference(Condition) | Health issues this plan addresses | ||||
| supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
| activity | C | 1..* | BackboneElement | Action to occur 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 | ||||
| outcomeCodeableConcept | S | 0..* | CodeableConcept | Results of the activity Binding: ARV treatment outcomes (required) | ||||
| id | 0..1 | string | 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 | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: Interruptions in treatment | ||||
| outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
| progress | 0..* | Annotation | Comments about the activity status/progress | |||||
| reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
| detail | SC | 0..1 | BackboneElement | In-line definition of activity | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| artRegimenSwitchedOrSubstituted | S | 0..1 | CodeableConcept | ART Regimen Switched Or Substituted URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-switched-or-substituted Binding: ART Regimen Change Types (required) | ||||
| artRegimenLine | S | 0..1 | CodeableConcept | ART Regimen Line URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/art-regimen-line Binding: ART Regimen Lines (required) | ||||
| next-visit | S | 0..1 | dateTime | Next Appointment Date URL: http://openhie.org/fhir/training-solution-1/StructureDefinition/hiv-care-next-visit | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| kind | S | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. Required Pattern: MedicationRequest | ||||
| instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
| code | S | 0..1 | CodeableConcept | Detail type of activity Binding: ARV Treatment Medication Request (required) | ||||
| id | 0..1 | string | 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 | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV medication request | ||||
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): 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. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
| statusReason | 0..1 | CodeableConcept | Reason for current status | |||||
| doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
| Slices for scheduled[x] | 0..1 | When activity is to occur Slice: Unordered, Open by type:$this | ||||||
| scheduledTiming | Timing | |||||||
| scheduledPeriod | Period | |||||||
| scheduledString | string | |||||||
| scheduled[x]:scheduledPeriod | S | 0..1 | Period | When activity is to occur | ||||
| location | 0..1 | Reference(Location) | Where it should happen | |||||
| performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
| Slices for product[x] | 0..1 | What is to be administered/supplied Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
| productCodeableConcept | CodeableConcept | |||||||
| productReference | Reference(Medication | Substance) | |||||||
| product[x]:productCodeableConcept | S | 0..1 | CodeableConcept | What is to be administered/supplied Binding: A list of ARV regimen (required) | ||||
| id | 0..1 | string | 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 | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: ARV Regimen | ||||
| dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
| quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
| description | 0..1 | string | Extra info describing activity to perform | |||||
| note | S | 0..* | Annotation | Comments about the plan | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1from the FHIR Standard | ||||
| CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1from the FHIR Standard | ||||
| CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-categoryfrom the FHIR Standard | ||||
| CarePlan.activity.outcomeCodeableConcept | required | VSCarePlanActivityOutcomehttp://openhie.org/fhir/training-solution-1/ValueSet/vs-careplan-outcomefrom this IG | ||||
| CarePlan.activity.detail.kind | required | Pattern: MedicationRequesthttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.code | required | VSARVMedicationRequesthttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arvtreatment-activity-typefrom this IG | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findingsfrom the FHIR Standard | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1from the FHIR Standard | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| CarePlan.activity.detail.product[x]:productCodeableConcept | required | VSARVRegimenhttp://openhie.org/fhir/training-solution-1/ValueSet/vs-arv-regimenfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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() |
This structure is derived from CarePlan
Summary
Mandatory: 3 elements
Must-Support: 10 elements
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Jembi Health Systems. Package openhie.fhir.training.solution.1#0.1.0 based on FHIR 4.0.1. Generated 2024-01-27
Links: Table of Contents |
QA Report |
Version History |
|