Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Te Whatu Ora Shared Care FHIR API
0.4.0 - release
Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions
| Active as of 2023-07-27 |
{
"resourceType" : "PlanDefinition",
"meta" : {
"versionId" : "3",
"lastUpdated" : "2022-09-12T04:46:55.848Z",
"profile" : [
🔗 "https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/ManaakiNgaTahiPlanDefinition"
]
},
"language" : "en-NZ",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en-NZ\" lang=\"en-NZ\"><p><b>Generated Narrative: PlanDefinition </b><a name=\"PlanDefinitionExample\"> </a><a name=\"hcPlanDefinitionExample\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">ResourcePlanDefinition "PlanDefinitionExample" Version"3" Updated"2022-09-12 04:46:55+0000" (Language"en-NZ") </p><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-ManaakiNgaTahiPlanDefinition.html\">ManaakiNgaTahiPlanDefinition</a></p></div><p><b>url</b>: <code>https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/PlanDefinition/PlanDefinitionExample</code></p><p><b>identifier</b>: CareplanTemplate-CitC-COVID19-CCCM\u00a0(use:\u00a0usual,\u00a0period:\u00a02022-09-12 --> (ongoing))</p><p><b>version</b>: 1.0.0</p><p><b>name</b>: COVIDMVPCarePlanTemplate</p><p><b>title</b>: Template for COVID-19 Care in the Community CCCM MVP Careplans</p><p><b>subtitle</b>: Care in the Community plans to handle low risk COVID-19 cases</p><p><b>type</b>: Order Set <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-plan-definition-type.html\">PlanDefinitionType</a>#order-set)</span></p><p><b>status</b>: active</p><p><b>experimental</b>: true</p><p><b>subject</b>: Patient <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://hl7.org/fhir/R4/codesystem-resource-types.html\">ResourceType</a>#Patient)</span></p><p><b>date</b>: 2023-07-27</p><p><b>publisher</b>: Te Whatu Ora</p><p><b>contact</b>: Te Whatu Ora: <a href=\"https://www.tewhatuora.govt.nz/\">https://www.tewhatuora.govt.nz/</a>, David Grainger: <a href=\"mailto:david.grainger@middleware.co.nz\">david.grainger@middleware.co.nz</a></p><p><b>description</b>: A Care plan with a finite set of activities including medication delivery, heath checks, self applied RAT test and follow up GP Check which supports a low to medium COVID-19 infected patient.</p><p><b>jurisdiction</b>: New Zealand <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-ISO3166Part1.html\">ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code</a>#NZ)</span></p><p><b>purpose</b>: A care plan which supports a patient who has tested positive for COVID-19 infection and will isolate at home and self serve as appropriate as they recover.</p><p><b>usage</b>: Allows monitoring and tracking of progress of a self serve COVID-19 patient.</p><p><b>lastReviewDate</b>: 2022-08-04</p><p><b>effectivePeriod</b>: 2022-08-04 --> 2023-08-04</p><p><b>topic</b>: Treatment <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-definition-topic.html\">DefinitionTopic</a>#treatment)</span></p><p><b>author</b>: CinC Fit for Future Project</p><p><b>editor</b>: CinC Fit for Future Project</p><p><b>reviewer</b>: CinC Fit for Future Project</p><p><b>endorser</b>: CinC Fit for Future Project</p><blockquote><p><b>goal</b></p><blockquote><p><b>id</b></p>covid-recovery</blockquote><p><b>category</b>: Full Recovery <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>description</b>: Activities in the Self Serve COVID-19 Care Plan are intended to monitor progress of a patient who self isolates and self serves as they recover from a COVID-19 infection, to ensure they receive the appropriate level of care throughout (physical, financial, mental, social, family, spiritual). <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>priority</b>: Medium Priority <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-goal-priority.html\">Goal priority</a>#medium-priority)</span></p><p><b>start</b>: Exposure to coronavirus infection (event) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> ()</span></p><p><b>addresses</b>: At risk of dehydration <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#704420006; <a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#267036007 "Shortness of breath")</span></p><blockquote><p><b>target</b></p><p><b>measure</b>: Oxygen Saturation <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://loinc.org/\">LOINC</a>#20564-1 "Oxygen saturation in Blood")</span></p><p><b>detail</b>: 99 percent<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code% = '%')</span></p><h3>Dues</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Value</b></td><td><b>Unit</b></td><td><b>System</b></td><td><b>Code</b></td></tr><tr><td style=\"display: none\">*</td><td>5</td><td>days</td><td><a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-ucum.html\">Unified Code for Units of Measure (UCUM)</a></td><td>d</td></tr></table></blockquote></blockquote><blockquote><p><b>action</b></p><blockquote><p><b>id</b></p>1</blockquote><p><b>prefix</b>: 1.</p><p><b>title</b>: Health Check</p><p><b>description</b>: Health Check</p><p><b>textEquivalent</b>: Health check to monitor conditions and enable ability to make decisions on continuing with care plan</p><p><b>priority</b>: urgent</p><p><b>goalId</b>: covid-recovery</p><p><b>subject</b>: Patient <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://hl7.org/fhir/R4/codesystem-resource-types.html\">ResourceType</a>#Patient)</span></p><p><b>type</b>: Create <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/5.5.0/CodeSystem-action-type.html\">ActionType</a>#create)</span></p><p><b>requiredBehavior</b>: must</p><p><b>precheckBehavior</b>: yes</p><p><b>cardinalityBehavior</b>: multiple</p><p><b>definition</b>: <a href=\"Questionnaire-COVIDRegularHealthCheckQuestionnaire.html\">Question Template for COVID-19 Regular Health Check</a></p></blockquote></div>"
},
"url" : "https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/PlanDefinition/PlanDefinitionExample",
"identifier" : [
{
"use" : "usual",
"value" : "CareplanTemplate-CitC-COVID19-CCCM",
"period" : {
"start" : "2022-09-12"
}
}
],
"version" : "1.0.0",
"name" : "COVIDMVPCarePlanTemplate",
"title" : "Template for COVID-19 Care in the Community CCCM MVP Careplans",
"subtitle" : "Care in the Community plans to handle low risk COVID-19 cases",
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/plan-definition-type",
"code" : "order-set",
"display" : "Order Set"
}
],
"text" : "Order Set"
},
"status" : "active",
"experimental" : true,
"subjectCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/resource-types",
"code" : "Patient",
"display" : "Patient"
}
],
"text" : "Patient"
},
"date" : "2023-07-27",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://www.tewhatuora.govt.nz/"
}
]
},
{
"name" : "David Grainger",
"telecom" : [
{
"system" : "email",
"value" : "david.grainger@middleware.co.nz",
"use" : "work"
}
]
}
],
"description" : "A Care plan with a finite set of activities including medication delivery, heath checks, self applied RAT test and follow up GP Check which supports a low to medium COVID-19 infected patient.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "NZ",
"display" : "New Zealand"
}
]
}
],
"purpose" : "A care plan which supports a patient who has tested positive for COVID-19 infection and will isolate at home and self serve as appropriate as they recover.",
"usage" : "Allows monitoring and tracking of progress of a self serve COVID-19 patient.",
"lastReviewDate" : "2022-08-04",
"effectivePeriod" : {
"start" : "2022-08-04",
"end" : "2023-08-04"
},
"topic" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/definition-topic",
"code" : "treatment",
"display" : "Treatment"
}
],
"text" : "Treatment"
}
],
"author" : [
{
"telecom" : [
{
"system" : "other",
"value" : "CinC Fit for Future Project"
}
]
}
],
"editor" : [
{
"telecom" : [
{
"system" : "other",
"value" : "CinC Fit for Future Project"
}
]
}
],
"reviewer" : [
{
"telecom" : [
{
"system" : "other",
"value" : "CinC Fit for Future Project"
}
]
}
],
"endorser" : [
{
"telecom" : [
{
"system" : "other",
"value" : "CinC Fit for Future Project"
}
]
}
],
"goal" : [
{
"id" : "covid-recovery",
"category" : {
"text" : "Full Recovery"
},
"description" : {
"text" : "Activities in the Self Serve COVID-19 Care Plan are intended to monitor progress of a patient who self isolates and self serves as they recover from a COVID-19 infection, to ensure they receive the appropriate level of care throughout (physical, financial, mental, social, family, spiritual)."
},
"priority" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/goal-priority",
"code" : "medium-priority",
"display" : "Medium Priority"
}
],
"text" : "Medium Priority"
},
"start" : {
"text" : "Exposure to coronavirus infection (event)"
},
"addresses" : [
{
"coding" : [
{
"system" : "http://snomed.info/sct",
"code" : "704420006",
"display" : "At risk of dehydration"
},
{
"system" : "http://snomed.info/sct",
"code" : "267036007",
"display" : "Shortness of breath"
}
]
}
],
"target" : [
{
"measure" : {
"coding" : [
{
"system" : "http://loinc.org",
"code" : "20564-1",
"display" : "Oxygen saturation in Blood"
}
],
"text" : "Oxygen Saturation"
},
"detailQuantity" : {
"value" : 99,
"unit" : "percent",
"system" : "http://unitsofmeasure.org",
"code" : "%"
},
"due" : {
"value" : 5,
"unit" : "days",
"system" : "http://unitsofmeasure.org",
"code" : "d"
}
}
]
}
],
"action" : [
{
"id" : "1",
"prefix" : "1.",
"title" : "Health Check",
"description" : "Health Check",
"textEquivalent" : "Health check to monitor conditions and enable ability to make decisions on continuing with care plan",
"priority" : "urgent",
"goalId" : [
"covid-recovery"
],
"subjectCodeableConcept" : {
"coding" : [
{
"system" : "http://hl7.org/fhir/resource-types",
"code" : "Patient",
"display" : "Patient"
}
],
"text" : "Patient"
},
"type" : {
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/action-type",
"code" : "create",
"display" : "Create"
}
],
"text" : "Create"
},
"requiredBehavior" : "must",
"precheckBehavior" : "yes",
"cardinalityBehavior" : "multiple",
"definitionCanonical" : "https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/Questionnaire/COVIDRegularHealthCheckQuestionnaire"
}
]
}