STU 2 Ballot
This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) v1.6.0. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions
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:
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:
Profile specific implementation guidance:
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
Goal.subjectGoal.descriptionGoal.status which has an required binding to:
This structure is derived from Goal
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Goal | I | 0..* | 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..1 | id | 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External Ids for this goal | |
 subject | S | 1..1 | Reference(Profile daf-core-patient) | Who this goal is intended for |
 start[x] | ∑ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
| target[x] | ∑ | 0..1 | date, Duration | Reach goal on or before |
| category | ∑ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
| description | S | 1..1 | CodeableConcept | Code or text describing goal Binding: (unbound) (example) |
| status | ?!S | 1..1 | code | proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target Binding: GoalStatus (required) |
| statusDate | ∑ | 0..1 | date | When goal status took effect |
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: GoalStatusReason (example) | |
| expressedBy | ∑ | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| priority | ∑ | 0..1 | CodeableConcept | high | medium |low Binding: GoalPriority (preferred) |
| addresses | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionRequest | ProcedureRequest | RiskAssessment) | Issues addressed by this goal | |
| note | 0..* | Annotation | Comments about the goal | |
 outcome | 0..* | BackboneElement | What was end result of goal? | |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| result[x] | 0..1 | CodeableConcept, Reference(Observation) | Code or observation that resulted from goal Binding: (unbound) (example) | |
| Documentation for this format | ||||
yet to be done: Xml template
yet to be done: Json template
This structure is derived from Goal
Differential View
This structure is derived from Goal
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | I | 0..* | 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..1 | id | 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..* | Identifier | External Ids for this goal | |
| subject | S | 1..1 | Reference(Profile daf-core-patient) | Who this goal is intended for |
| start[x] | ∑ | 0..1 | date, CodeableConcept | When goal pursuit begins Binding: GoalStartEvent (example) |
| target[x] | ∑ | 0..1 | date, Duration | Reach goal on or before |
| category | ∑ | 0..* | CodeableConcept | E.g. Treatment, dietary, behavioral, etc. Binding: GoalCategory (example) |
| description | S | 1..1 | CodeableConcept | Code or text describing goal Binding: (unbound) (example) |
| status | ?!S | 1..1 | code | proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled | on-target | ahead-of-target | behind-target Binding: GoalStatus (required) |
| statusDate | ∑ | 0..1 | date | When goal status took effect |
| statusReason | 0..* | CodeableConcept | Reason for current status Binding: GoalStatusReason (example) | |
| expressedBy | ∑ | 0..1 | Reference(Patient | Practitioner | RelatedPerson) | Who's responsible for creating Goal? |
| priority | ∑ | 0..1 | CodeableConcept | high | medium |low Binding: GoalPriority (preferred) |
| addresses | 0..* | Reference(Condition | Observation | MedicationStatement | NutritionRequest | ProcedureRequest | RiskAssessment) | Issues addressed by this goal | |
| note | 0..* | Annotation | Comments about the goal | |
| outcome | 0..* | BackboneElement | What was end result of goal? | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
| result[x] | 0..1 | CodeableConcept, Reference(Observation) | Code or observation that resulted from goal Binding: (unbound) (example) | |
| 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
| Path | Name | Conformance | ValueSet |
| Goal.language | Common Languages | extensible | Common Languages |
| Goal.start[x] | GoalStartEvent | example | GoalStartEvent |
| Goal.category | GoalCategory | example | GoalCategory |
| Goal.description | ?ext | example | |
| Goal.status | GoalStatus | required | GoalStatus |
| Goal.statusReason | GoalStatusReason | example | GoalStatusReason |
| Goal.priority | GoalPriority | preferred | GoalPriority |
| Goal.outcome.result[x] | ?ext | example |
| Id | Path | Details | Requirements |
| dom-2 | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
| dom-1 | Goal | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
| dom-4 | Goal | If 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-3 | Goal | If 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))])) |
© HL7.org 2011+. DAF STU 2 Ballot (v1.6.0-9635) generated on Thu, Aug 11, 2016 20:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
|
Propose a change 