MaxMD AMA IG
0.0.1 - CI Build

MaxMD AMA IG - Local Development build (v0.0.1). See the Directory of published versions

Resource Profile: USCoreGoalProfile

Defines constraints and extensions on the Goal resource for the minimal set of data to query and retrieve a patient’s goal(s).

The official URL for this profile is:

http://hl7.maxmd.org/fhir/us/core/StructureDefinition/us-core-maxmd-goal

Formal Views of Profile Content

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

This structure is derived from Goal

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

This structure is derived from Goal

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... description S1..1CodeableConceptCode or text describing goal
... subject S1..1Reference(US Core Patient Profile)Who this goal is intended for
.... dueDate S0..1dateReach goal on or before

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*GoalDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣI1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... achievementStatus ΣI0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred)
... category ΣI0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority ΣI0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣI1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example)
... subject SΣI1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] ΣI0..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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... measure ΣI0..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example)
.... detail[x] ΣI0..1The target value to be achieved
Binding: (unbound) (example)
..... detailQuantityQuantity
..... detailRangeRange
..... detailCodeableConceptCodeableConcept
..... detailStringstring
..... detailBooleanboolean
..... detailIntegerinteger
..... detailRatioRatio
.... due[x] ΣI0..1(Slice Definition)Reach goal on or before
Slice: Unordered, Closed by type:$this
..... due[x]:dueDate SΣI0..1dateReach goal on or before
... statusDate ΣI0..1dateWhen goal status took effect
... statusReason I0..1stringReason for current status
... expressedBy ΣI0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses I0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... note I0..*AnnotationComments about the goal
... outcomeCode I0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMEDCTClinicalFindings (example)
... outcomeReference I0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

This structure is derived from Goal

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Goal

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*GoalDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... description S1..1CodeableConceptCode or text describing goal
... subject S1..1Reference(US Core Patient Profile)Who this goal is intended for
.... dueDate S0..1dateReach goal on or before

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*GoalDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣI1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required)
... achievementStatus ΣI0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred)
... category ΣI0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... priority ΣI0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred)
... description SΣI1..1CodeableConceptCode or text describing goal
Binding: SNOMEDCTClinicalFindings (example)
... subject SΣI1..1Reference(US Core Patient Profile)Who this goal is intended for
... start[x] ΣI0..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 I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... measure ΣI0..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example)
.... detail[x] ΣI0..1The target value to be achieved
Binding: (unbound) (example)
..... detailQuantityQuantity
..... detailRangeRange
..... detailCodeableConceptCodeableConcept
..... detailStringstring
..... detailBooleanboolean
..... detailIntegerinteger
..... detailRatioRatio
.... due[x] ΣI0..1(Slice Definition)Reach goal on or before
Slice: Unordered, Closed by type:$this
..... due[x]:dueDate SΣI0..1dateReach goal on or before
... statusDate ΣI0..1dateWhen goal status took effect
... statusReason I0..1stringReason for current status
... expressedBy ΣI0..1Reference(Patient | Practitioner | PractitionerRole | RelatedPerson)Who's responsible for creating Goal?
... addresses I0..*Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment)Issues addressed by this goal
... note I0..*AnnotationComments about the goal
... outcomeCode I0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMEDCTClinicalFindings (example)
... outcomeReference I0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Goal.languagepreferredCommonLanguages
Max Binding: AllLanguages
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.achievementStatuspreferredGoalAchievementStatus
Goal.categoryexampleGoalCategory
Goal.prioritypreferredGoalPriority
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.start[x]exampleGoalStartEvent
Goal.target.measureexampleLOINCCodes
Goal.target.detail[x]example
Goal.outcomeCodeexampleSNOMEDCTClinicalFindings

Constraints

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