MCC eCare Plan Draft Implementation Guide
0.1.0 - CI Build
MCC eCare Plan Draft Implementation Guide
0.1.0 - CI Build
MCC eCare Plan Draft Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
| Defining URL: | http://hl7.org/fhir/us/mcc/StructureDefinition/CalciumLevelTarget |
| Version: | 0.1.0 |
| Name: | CalciumLevelTarget |
| Title: | Calcium Level Target |
| Status: | Draft as of 2020-09-22 |
| Definition: | This profile constrains US Core Goal to focus on goals for calcium levels. |
| Publisher: | HL7 International - Patient Care WG |
| Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/mcc/StructureDefinition/CalciumLevelTarget
The US Core Goal Profile sets minimum expectations for the Goal resource resource to record, search, and fetch Goal information associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile. In addition to the requirements set in the US Core Goal Profile, in this profile, Goal.target.measure is “Must Support” and is bound to a Calcium level value set. Goal.expressedBy is also constrained to “Must Support”.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreGoalProfile
This structure is derived from USCoreGoalProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Goal | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
  extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:goal-acceptance | S | 0..* | Extension | Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-acceptance |
| extension:reasonRejected | S | 0..* | Extension | The reason the goal was not accepted. Applies only if the status of the goal is rejected. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected |
| extension:goal-relationship | S | 0..* | Extension | Establishes a relationship between this goal and other goals. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship |
 achievementStatus | S | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
| priority | S | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority |
 target | ||||
  measure | S | 0..1 | CodeableConcept | Corrected Calcium Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.122/expansion (required) |
| expressedBy | S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal |
| outcomeReference | S | 0..* | Reference(Observation) | Observation that resulted from goal |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
 id | Σ | 0..1 | string | 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) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:goal-acceptance | S | 0..* | Extension | Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-acceptance |
| extension:reasonRejected | S | 0..* | Extension | The reason the goal was not accepted. Applies only if the status of the goal is rejected. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected |
| extension:goal-relationship | S | 0..* | Extension | Establishes a relationship between this goal and other goals. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External Ids for this goal | |
| lifecycleStatus | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
| achievementStatus | SΣ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred) |
| category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
| priority | SΣ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
| description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example) |
 subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
 start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example) | |
| startDate | date | |||
| startCodeableConcept | CodeableConcept | |||
| target | SI | 0..* | BackboneElement | Target outcome for the goal |
| 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 |
| measure | SΣI | 0..1 | CodeableConcept | Corrected Calcium Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.122/expansion (required) |
| detail[x] | ΣI | 0..1 | The target value to be achieved Binding: (unbound) (example) | |
| detailQuantity | Quantity | |||
| detailRange | Range | |||
| detailCodeableConcept | CodeableConcept | |||
| detailString | string | |||
| detailBoolean | boolean | |||
| detailInteger | integer | |||
| detailRatio | Ratio | |||
  due[x] | Σ | 0..1 | (Slice Definition) | Reach goal on or before Slice: Unordered, Closed by type:$this |
  due[x]:dueDate | SΣ | 0..1 | date | Reach goal on or before |
| statusDate | Σ | 0..1 | date | When goal status took effect |
| statusReason | 0..1 | string | Reason for current status | |
| expressedBy | SΣ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal |
| note | 0..* | Annotation | Comments about the goal | |
| outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example) | |
| outcomeReference | S | 0..* | Reference(Observation) | Observation that resulted from goal |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
| extension:goal-acceptance | 0..* | Extension | Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-acceptance | |
| extension:reasonRejected | 0..* | Extension | The reason the goal was not accepted. Applies only if the status of the goal is rejected. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected | |
| extension:goal-relationship | 0..* | Extension | Establishes a relationship between this goal and other goals. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship | |
| lifecycleStatus | ?!Σ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
| achievementStatus | Σ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred) |
| priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
| description | Σ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example) |
| subject | Σ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
| target | I | 0..* | BackboneElement | Target outcome for the goal |
| measure | ΣI | 0..1 | CodeableConcept | Corrected Calcium Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.122/expansion (required) |
| due[x]:dueDate | Σ | 0..1 | date | Reach goal on or before |
| expressedBy | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal | |
| outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |
| Documentation for this format | ||||
This structure is derived from USCoreGoalProfile
Differential View
This structure is derived from USCoreGoalProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:goal-acceptance | S | 0..* | Extension | Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-acceptance |
| extension:reasonRejected | S | 0..* | Extension | The reason the goal was not accepted. Applies only if the status of the goal is rejected. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected |
| extension:goal-relationship | S | 0..* | Extension | Establishes a relationship between this goal and other goals. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship |
| achievementStatus | S | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable |
| priority | S | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority |
| target | ||||
| measure | S | 0..1 | CodeableConcept | Corrected Calcium Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.122/expansion (required) |
| expressedBy | S | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal |
| outcomeReference | S | 0..* | Reference(Observation) | Observation that resulted from goal |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | USCoreGoalProfile | Describes the intended objective(s) for a patient, group or organization | |
| id | Σ | 0..1 | string | 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) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:goal-acceptance | S | 0..* | Extension | Information about the acceptance and relative priority assigned to the goal by the patient, practitioners and other stake-holders. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-acceptance |
| extension:reasonRejected | S | 0..* | Extension | The reason the goal was not accepted. Applies only if the status of the goal is rejected. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-reasonRejected |
| extension:goal-relationship | S | 0..* | Extension | Establishes a relationship between this goal and other goals. Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External Ids for this goal | |
| lifecycleStatus | ?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
| achievementStatus | SΣ | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred) |
| category | Σ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
| priority | SΣ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
| description | SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example) |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
| start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example) | |
| startDate | date | |||
| startCodeableConcept | CodeableConcept | |||
| target | SI | 0..* | BackboneElement | Target outcome for the goal |
| 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 |
| measure | SΣI | 0..1 | CodeableConcept | Corrected Calcium Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.122/expansion (required) |
| detail[x] | ΣI | 0..1 | The target value to be achieved Binding: (unbound) (example) | |
| detailQuantity | Quantity | |||
| detailRange | Range | |||
| detailCodeableConcept | CodeableConcept | |||
| detailString | string | |||
| detailBoolean | boolean | |||
| detailInteger | integer | |||
| detailRatio | Ratio | |||
| due[x] | Σ | 0..1 | (Slice Definition) | Reach goal on or before Slice: Unordered, Closed by type:$this |
| due[x]:dueDate | SΣ | 0..1 | date | Reach goal on or before |
| statusDate | Σ | 0..1 | date | When goal status took effect |
| statusReason | 0..1 | string | Reason for current status | |
| expressedBy | SΣ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
| addresses | S | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal |
| note | 0..* | Annotation | Comments about the goal | |
| outcomeCode | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example) | |
| outcomeReference | S | 0..* | Reference(Observation) | Observation that resulted from goal |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| Goal.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Goal.lifecycleStatus | required | GoalLifecycleStatus |
| Goal.achievementStatus | preferred | GoalAchievementStatus |
| Goal.category | example | GoalCategory |
| Goal.priority | preferred | GoalPriority |
| Goal.description | example | SNOMEDCTClinicalFindings |
| Goal.start[x] | example | GoalStartEvent |
| Goal.target.measure | required | https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.122/expansion |
| Goal.target.detail[x] | example | |
| Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
| Id | Path | Details | Requirements |
| dom-2 | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Goal | 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 | Goal | 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 | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Goal.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.extension:goal-acceptance | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.extension:goal-acceptance | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.extension:reasonRejected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.extension:reasonRejected | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.extension:goal-relationship | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.extension:goal-relationship | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.lifecycleStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.achievementStatus | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.category | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.start[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| gol-1 | Goal.target | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() | |
| ele-1 | Goal.target.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.target.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.target.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Goal.target.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Goal.target.measure | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.target.detail[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.target.due[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.target.due[x]:dueDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.statusDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.expressedBy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.addresses | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.outcomeCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Goal.outcomeReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.mcc#0.1.0 based on FHIR 4.0.1. Generated 2020-11-02
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change