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

Resource Profile: Bicarbonate Level Target

Defining URL:http://hl7.org/fhir/us/mcc/StructureDefinition/BicarbonateLevelTarget
Version:0.1.0
Name:BicarbonateLevelTarget
Title:Bicarbonate Level Target
Status:Draft as of 2020-09-22
Definition:

This profile constrains US Core Goal to focus on goals for serum bicarbonate 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/BicarbonateLevelTarget

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 bicarbonate level value set. Goal.expressedBy is also constrained to “Must Support”.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from USCoreGoalProfile

Summary

Must-Support: 9 elements
Fixed Value: 3 elements

This structure is derived from USCoreGoalProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*USCoreGoalProfileDescribes the intended objective(s) for a patient, group or organization
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:goal-acceptance S0..*ExtensionInformation 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 S0..*ExtensionThe 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
... achievementStatus S0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
... priority S0..1CodeableConcepthigh-priority | medium-priority | low-priority
... target
.... measure S0..1CodeableConceptSerum Bicarbonate
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.130/expansion (required)
... expressedBy S0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses S0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... outcomeReference S0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*USCoreGoalProfileDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:goal-acceptance S0..*ExtensionInformation 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 S0..*ExtensionThe 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 S0..*ExtensionEstablishes a relationship between this goal and other goals.

Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... achievementStatus SΣ0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred)
... category Σ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority SΣ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example)
... subject SΣ1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] Σ0..1When goal pursuit begins
Binding: GoalStartEvent (example)
.... startDatedate
.... startCodeableConceptCodeableConcept
... target SI0..*BackboneElementTarget outcome for the goal
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... measure SΣI0..1CodeableConceptSerum Bicarbonate
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.130/expansion (required)
.... detail[x] ΣI0..1The target value to be achieved
Binding: (unbound) (example)
..... detailQuantityQuantity
..... detailRangeRange
..... detailCodeableConceptCodeableConcept
..... detailStringstring
..... detailBooleanboolean
..... detailIntegerinteger
..... detailRatioRatio
.... due[x] Σ0..1(Slice Definition)Reach goal on or before
Slice: Unordered, Closed by type:$this
..... due[x]:dueDate SΣ0..1dateReach goal on or before
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy SΣ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses S0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMEDCTClinicalFindings (example)
... outcomeReference S0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*USCoreGoalProfileDescribes the intended objective(s) for a patient, group or organization
... extension:goal-acceptance 0..*ExtensionInformation 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..*ExtensionThe 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..*ExtensionEstablishes a relationship between this goal and other goals.

Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship
... achievementStatus Σ0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred)
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description Σ1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example)
... subject Σ1..1Reference(US Core Patient Profile)Who this goal is intended for
... target I0..*BackboneElementTarget outcome for the goal
.... measure ΣI0..1CodeableConceptSerum Bicarbonate
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.130/expansion (required)
.... due[x]:dueDate Σ0..1dateReach goal on or before
... expressedBy Σ0..1Reference(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

doco Documentation for this format

This structure is derived from USCoreGoalProfile

Summary

Must-Support: 9 elements
Fixed Value: 3 elements

Differential View

This structure is derived from USCoreGoalProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*USCoreGoalProfileDescribes the intended objective(s) for a patient, group or organization
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:goal-acceptance S0..*ExtensionInformation 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 S0..*ExtensionThe 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
... achievementStatus S0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
... priority S0..1CodeableConcepthigh-priority | medium-priority | low-priority
... target
.... measure S0..1CodeableConceptSerum Bicarbonate
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.130/expansion (required)
... expressedBy S0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses S0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... outcomeReference S0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*USCoreGoalProfileDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:goal-acceptance S0..*ExtensionInformation 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 S0..*ExtensionThe 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 S0..*ExtensionEstablishes a relationship between this goal and other goals.

Fixed Value: http://hl7.org/fhir/StructureDefinition/goal-relationship
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... achievementStatus SΣ0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred)
... category Σ0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority SΣ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣ1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example)
... subject SΣ1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] Σ0..1When goal pursuit begins
Binding: GoalStartEvent (example)
.... startDatedate
.... startCodeableConceptCodeableConcept
... target SI0..*BackboneElementTarget outcome for the goal
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... measure SΣI0..1CodeableConceptSerum Bicarbonate
Binding: https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.130/expansion (required)
.... detail[x] ΣI0..1The target value to be achieved
Binding: (unbound) (example)
..... detailQuantityQuantity
..... detailRangeRange
..... detailCodeableConceptCodeableConcept
..... detailStringstring
..... detailBooleanboolean
..... detailIntegerinteger
..... detailRatioRatio
.... due[x] Σ0..1(Slice Definition)Reach goal on or before
Slice: Unordered, Closed by type:$this
..... due[x]:dueDate SΣ0..1dateReach goal on or before
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy SΣ0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses S0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMEDCTClinicalFindings (example)
... outcomeReference S0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Goal.languagepreferredCommonLanguages
Max Binding: AllLanguages
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.achievementStatuspreferredGoalAchievementStatus
Goal.categoryexampleGoalCategory
Goal.prioritypreferredGoalPriority
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.start[x]exampleGoalStartEvent
Goal.target.measurerequiredhttps://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1222.130/expansion
Goal.target.detail[x]example
Goal.outcomeCodeexampleSNOMEDCTClinicalFindings

Constraints

IdPathDetailsRequirements
dom-2GoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3GoalIf 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-4GoalIf 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-5GoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6GoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1Goal.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.extension:goal-acceptanceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.extension:goal-acceptanceMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.extension:reasonRejectedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.extension:reasonRejectedMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.extension:goal-relationshipAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.extension:goal-relationshipMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.lifecycleStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.achievementStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.priorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.start[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
gol-1Goal.targetGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()
ele-1Goal.target.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.target.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.target.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Goal.target.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Goal.target.measureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.target.detail[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.target.due[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.target.due[x]:dueDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.statusDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.statusReasonAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.expressedByAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.addressesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.outcomeCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Goal.outcomeReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())