Primary care data acquisition API
0.2.0 - ci-build
Primary care data acquisition API
0.2.0 - ci-build
Primary care data acquisition API, published by Health New Zealand. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-primary-care-acquisition/ and changes regularly. See the Directory of published versions
| Draft as of 2024-04-15 |
{
"resourceType" : "CapabilityStatement",
"id" : "PrimaryCareAcquisitionCapabliityStatement",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement PrimaryCareAcquisitionCapabliityStatement</b></p><a name=\"PrimaryCareAcquisitionCapabliityStatement\"> </a><a name=\"hcPrimaryCareAcquisitionCapabliityStatement\"> </a><a name=\"PrimaryCareAcquisitionCapabliityStatement-en-US\"> </a><h2 id=\"title\">Primary Care Data Acquisition API</h2><ul><li>Implementation Guide Version: 0.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-04-15 01:15:23+0000 </li><li>Published by: Health New Zealand </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>OAuth</code></div></div><blockquote><div><p>OAuth 2.0 - Client Credential flow.)</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#AllergyIntolerance1-1\">AllergyIntolerance</a></td><td>https://standards.digital.health.nz/StructureDefinition/PrimaryCareAllergyIntolerance</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Condition1-2\">Condition</a></td><td><a href=\"StructureDefinition-PrimaryCareCondition.html\">https://standards.digital.health.nz/StructureDefinition/PrimaryCareCondition</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Consent1-3\">Consent</a></td><td><a href=\"StructureDefinition-PrimaryCareConsent.html\">https://standards.digital.health.nz/StructureDefinition/PrimaryCareConsent</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Encounter1-4\">Encounter</a></td><td><a href=\"StructureDefinition-PrimaryCareEncounter.html\">https://standards.digital.health.nz/StructureDefinition/PrimaryCareEncounter</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-5\">Observation</a></td><td><a href=\"StructureDefinition-PrimaryCareObservationVitalSigns.html\">https://standards.digital.health.nz/StructureDefinition/PrimaryCareObservationVitalSigns</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-6\">Observation</a></td><td><a href=\"StructureDefinition-PrimaryCareObservationVapingStatus.html\">https://standards.digital.health.nz/StructureDefinition/PrimaryCareObservationVapingStatus</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-7\">Observation</a></td><td><a href=\"StructureDefinition-PrimaryCareObservationSmokingStatus.html\">https://standards.digital.health.nz/StructureDefinition/PrimaryCareObservationSmokingStatus</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"AllergyIntolerance1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>AllergyIntolerance</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><code>https://standards.digital.health.nz/StructureDefinition/PrimaryCareAllergyIntolerance</code></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Condition1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Condition</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-PrimaryCareCondition.html\">PrimaryCareCondition</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Consent1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Consent</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-PrimaryCareConsent.html\">PrimaryCareConsent</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Encounter1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Encounter</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-PrimaryCareEncounter.html\">PrimaryCareEncounter</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-PrimaryCareObservationVitalSigns.html\">PrimaryCareObservationVitalSigns</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-PrimaryCareObservationVapingStatus.html\">PrimaryCareObservationVapingStatus</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Observation1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Observation</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-PrimaryCareObservationSmokingStatus.html\">PrimaryCareObservationSmokingStatus</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>create</code>, <code>update</code>, <code>search-type</code>.</li></ul></div></div><p/></div></div></div></div>"
},
"url" : "https://standards.digital.health.nz/CapabilityStatement/PrimaryCareAcquisitionCapabliityStatement",
"version" : "0.2.0",
"name" : "PrimaryCareAcquisitionCapabliityStatement",
"title" : "Primary Care Data Acquisition API",
"status" : "draft",
"experimental" : true,
"date" : "2024-04-15T01:15:23.3688326Z",
"publisher" : "Health New Zealand",
"contact" : [
{
"name" : "Health New Zealand",
"telecom" : [
{
"system" : "url",
"value" : "https://github.com/tewhatuora"
}
]
}
],
"description" : "Primary Care Data Acquisition API",
"kind" : "capability",
"software" : {
"name" : "Primary Care Data Acquisition API",
"version" : "1.0.0.0"
},
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "OAuth"
}
]
}
],
"description" : "OAuth 2.0 - Client Credential flow.)"
},
"resource" : [
{
"type" : "AllergyIntolerance",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareAllergyIntolerance",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
},
{
"type" : "Condition",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareCondition",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
},
{
"type" : "Consent",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareConsent",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
},
{
"type" : "Encounter",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareEncounter",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
},
{
"type" : "Observation",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareObservationVitalSigns",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
},
{
"type" : "Observation",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareObservationVapingStatus",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
},
{
"type" : "Observation",
"profile" : "https://standards.digital.health.nz/StructureDefinition/PrimaryCareObservationSmokingStatus",
"interaction" : [
{
"code" : "read"
},
{
"code" : "create"
},
{
"code" : "update"
},
{
"code" : "search-type"
}
]
}
]
}
]
}