MaxMD AMA IG - Local Development build (v0.0.1). See the Directory of published versions
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Goal
This structure is derived from Goal
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
lifecycleStatus | S | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
description | S | 1..1 | CodeableConcept | Code or text describing goal |
subject | S | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
target | S | 0..* | BackboneElement | Target outcome for the goal |
dueDate | S | 0..1 | date | Reach goal on or before |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | I | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | I | 0..* | Identifier | External Ids for this goal |
lifecycleStatus | ?!SΣI | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
achievementStatus | ΣI | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred) |
category | ΣI | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
priority | ΣI | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
description | SΣI | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example) |
subject | SΣI | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
start[x] | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example) |
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] | ΣI | 0..1 | (Slice Definition) | Reach goal on or before Slice: Unordered, Closed by type:$this |
due[x]:dueDate | SΣI | 0..1 | date | Reach goal on or before |
statusDate | ΣI | 0..1 | date | When goal status took effect |
statusReason | I | 0..1 | string | Reason for current status |
expressedBy | ΣI | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
addresses | I | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal |
note | I | 0..* | Annotation | Comments about the goal |
outcomeCode | I | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example) |
outcomeReference | I | 0..* | Reference(Observation) | Observation that resulted from goal |
Documentation for this format |
This structure is derived from Goal
Differential View
This structure is derived from Goal
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization | |
lifecycleStatus | S | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
description | S | 1..1 | CodeableConcept | Code or text describing goal |
subject | S | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
target | S | 0..* | BackboneElement | Target outcome for the goal |
dueDate | S | 0..1 | date | Reach goal on or before |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Goal | I | 0..* | Goal | Describes the intended objective(s) for a patient, group or organization |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
identifier | I | 0..* | Identifier | External Ids for this goal |
lifecycleStatus | ?!SΣI | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) |
achievementStatus | ΣI | 0..1 | CodeableConcept | in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable Binding: GoalAchievementStatus (preferred) |
category | ΣI | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
priority | ΣI | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred) |
description | SΣI | 1..1 | CodeableConcept | Code or text describing goal Binding: SNOMEDCTClinicalFindings (example) |
subject | SΣI | 1..1 | Reference(US Core Patient Profile) | Who this goal is intended for |
start[x] | ΣI | 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 | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
measure | ΣI | 0..1 | CodeableConcept | The parameter whose value is being tracked Binding: LOINCCodes (example) |
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] | ΣI | 0..1 | (Slice Definition) | Reach goal on or before Slice: Unordered, Closed by type:$this |
due[x]:dueDate | SΣI | 0..1 | date | Reach goal on or before |
statusDate | ΣI | 0..1 | date | When goal status took effect |
statusReason | I | 0..1 | string | Reason for current status |
expressedBy | ΣI | 0..1 | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) | Who's responsible for creating Goal? |
addresses | I | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) | Issues addressed by this goal |
note | I | 0..* | Annotation | Comments about the goal |
outcomeCode | I | 0..* | CodeableConcept | What result was achieved regarding the goal? Binding: SNOMEDCTClinicalFindings (example) |
outcomeReference | I | 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 | example | LOINCCodes |
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.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()) |