STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-core-goal

This profile sets minimum expectations for the Goal 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.

Example Usage Scenarios:

The following are example usage scenarios for the DAF-Goal profile:

  • Query for a Patient’s Goals
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each Goal must have:

  1. a patient
  2. text description of the goal
  3. a status

Profile specific implementation guidance:

  • none
Example: Goal Example: example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

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

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

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

This structure is derived from Goal

Complete Summary of the Mandatory Requirements

  1. A patient reference in Goal.subject
  2. A text description in Goal.description
  3. A status in Goal.status which has an required binding to:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*Describes the intended objective(s) for a patient, group or organization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id 0..1idLogical 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... subject S1..1Reference(Profile daf-core-patient)Who this goal is intended for
... start[x] 0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target[x] 0..1date, DurationReach goal on or before
... category 0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... description S1..1CodeableConceptCode or text describing goal
Binding: (unbound) (example)
... status ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target
Binding: GoalStatus (required)
... statusDate 0..1dateWhen goal status took effect
... statusReason 0..*CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... expressedBy 0..1Reference(Patient | Practitioner | RelatedPerson)Who's responsible for creating Goal?
... priority 0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... addresses 0..*Reference(Condition | Observation | MedicationStatement | NutritionRequest | ProcedureRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcome 0..*BackboneElementWhat was end result of goal?
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... result[x] 0..1CodeableConcept, Reference(Observation)Code or observation that resulted from goal
Binding: (unbound) (example)

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from Goal

Summary

Mandatory: 3 elements
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal I0..*Describes the intended objective(s) for a patient, group or organization
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... id 0..1idLogical 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... subject S1..1Reference(Profile daf-core-patient)Who this goal is intended for
... start[x] 0..1date, CodeableConceptWhen goal pursuit begins
Binding: GoalStartEvent (example)
... target[x] 0..1date, DurationReach goal on or before
... category 0..*CodeableConceptE.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example)
... description S1..1CodeableConceptCode or text describing goal
Binding: (unbound) (example)
... status ?!S1..1codeproposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target
Binding: GoalStatus (required)
... statusDate 0..1dateWhen goal status took effect
... statusReason 0..*CodeableConceptReason for current status
Binding: GoalStatusReason (example)
... expressedBy 0..1Reference(Patient | Practitioner | RelatedPerson)Who's responsible for creating Goal?
... priority 0..1CodeableConcepthigh | medium |low
Binding: GoalPriority (preferred)
... addresses 0..*Reference(Condition | Observation | MedicationStatement | NutritionRequest | ProcedureRequest | RiskAssessment)Issues addressed by this goal
... note 0..*AnnotationComments about the goal
... outcome 0..*BackboneElementWhat was end result of goal?
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... result[x] 0..1CodeableConcept, Reference(Observation)Code or observation that resulted from goal
Binding: (unbound) (example)

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Goal.languageCommon LanguagesextensibleCommon Languages
Goal.start[x]GoalStartEventexampleGoalStartEvent
Goal.categoryGoalCategoryexampleGoalCategory
Goal.description?extexample
Goal.statusGoalStatusrequiredGoalStatus
Goal.statusReasonGoalStatusReasonexampleGoalStatusReason
Goal.priorityGoalPrioritypreferredGoalPriority
Goal.outcome.result[x]?extexample

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2GoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1GoalIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4GoalIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3GoalIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.