Publication Build: This will be filled in by the publication tooling
| Official URL: http://iehr.ai/fhir/ie/core/StructureDefinition/ie-core-goal | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: IECoreGoalProfile | ||
| Other Identifiers: OID:1.3.6.1.4.1.54392.5.2690.42.26 | ||||
Copyright/Legal: iEHR.ai, all rights reserved Creative Commons License |
||||
The IE Core Goal Profile inherits from the FHIR Goal resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Goal resource to record, search, and fetch Goal information associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.
Example Usage Scenarios:
The following are example usage scenarios for this profile:
The following data elements must always be present (Mandatory definition) or must be supported if the data is present in the sending system (Must Support definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each Goal Must Have:
Each Goal Must Support:
*see guidance below
Profile Specific Implementation Guidance:
iEHR
Goal.startDate and Goal.target.dueDate are marked as Must Support, the server system is not required to support both, but SHALL support at least one of these elements. The client application SHALL support both elements.Goal.description.text when a concept isn't available or a legacy goal is not mapped to a LOINC or SNOMED concept.Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Goal |
0..* | Goal | 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-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| lifecycleStatus |
?!SΣ | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected Binding: GoalLifecycleStatus (required) ele-1: All FHIR elements must have a @value or children |
 description |
SΣ | 1..1 | CodeableConcept | Code or text describing goal Binding: IE Core Goal Codes (extensible): Value set to describe the Goal ele-1: All FHIR elements must have a @value or children |
 subject |
SΣ | 1..1 | Reference(IE Core Patient Profile) | Who this goal is intended for ele-1: All FHIR elements must have a @value or children |
 start[x] |
SΣ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. ele-1: All FHIR elements must have a @value or children | |
  startDate |
date | |||
| target |
SC | 0..* | BackboneElement | Target outcome for the goal ele-1: All FHIR elements must have a @value or children gol-1: Goal.target.measure is required if Goal.target.detail is populated |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| due[x] |
SΣ | 0..1 | Reach goal on or before ele-1: All FHIR elements must have a @value or children | |
| dueDate |
date | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Goal.lifecycleStatus | required | GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-statusfrom the FHIR Standard | |
| Goal.description | extensible | IECoreGoalCodeshttp://iehr.ai/fhir/ie/core/ValueSet/ie-core-goal-descriptionfrom this IG | |
| Goal.start[x] | example | GoalStartEventhttp://hl7.org/fhir/ValueSet/goal-start-eventfrom the FHIR Standard |
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the IE Core interactions to access this profile's information (Profile Support + Interaction Support). Note that systems that support only IE Core Profiles (Profile Only Support) are not required to support these interactions. See the IE Core Server CapabilityStatement for a complete list of supported RESTful interactions for this IG.
Servers providing access to goal data SHALL support these IE Core SMART Scopes:
<patient|user|system>/Goal.rsThe following search parameters and search parameter combinations SHALL be supported:
SHALL support searching for all goals for a patient using the patient search parameter:
GET [base]/Goal?patient={Type/}[id]
Example:
Implementation Notes: Fetches a bundle of all Goal resources for the specified patient (how to search by reference)
The following search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient and lifecycle-status search parameters:
GET [base]/Goal?patient={Type/}[id]&lifecycle-status={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and lifecycle-status (how to search by reference and how to search by token)
patient and target-date search parameters:
target-date comparators: gt,lt,ge,letarget-date (e.g.target-date=[date]&target-date=[date]]&...)GET [base]/Goal?patient={Type/}[id]&target-date={gt|lt|ge|le}[date]{&target-date={gt|lt|ge|le}[date]&...}
Example:
Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and target-date (how to search by reference and how to search by date)
SHOULD support searching using the combination of the patient and description search parameters:
GET [base]/Goal?patient={Type/}[id]&description={system|}[code]
Example:
Implementation Notes: Fetches a bundle of all Goal resources for the specified patient and description (how to search by reference and how to search by token)