Primary care data acquisition API
0.2.0 - ci-build

Primary care data acquisition API - Local Development build (v0.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Primary Care Data Acquisition API (Experimental)

Official URL: https://fhir-ig.digital.health.nz/primary-care-acquisition/CapabilityStatement/PrimaryCareAcquisitionCapabliityStatement Version: 0.2.0
Draft as of 2024-04-15 Computable Name: PrimaryCareAcquisitionCapabliityStatement

Primary Care Data Acquisition API

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement PrimaryCareAcquisitionCapabliityStatement

Primary Care Data Acquisition API

  • Implementation Guide Version: 0.2.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-04-15 01:15:23+0000
  • Published by: Health New Zealand

Note to Implementers: FHIR Capabilities

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.

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: yes
Security services supported: SMART-on-FHIR

OAuth 2.0 - Client Credential flow.)

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
AllergyIntolerancehttps://fhir-ig.digital.health.nz/primary-care-acquisition/StructureDefinition/PrimaryCareAllergyIntoleranceyyyy
Conditionhttps://fhir-ig.digital.health.nz/primary-care-acquisition/StructureDefinition/PrimaryCareConditionyyyy
Consenthttps://fhir-ig.digital.health.nz/primary-care-acquisition/StructureDefinition/PrimaryCareConsentyyyy
Encounterhttps://fhir-ig.digital.health.nz/primary-care-acquisition/StructureDefinition/PrimaryCareEncounteryyyy
Observationhttps://fhir-ig.digital.health.nz/primary-care-acquisition/StructureDefinition/PrimaryCareObservationSmokingStatusyyyy

Resource Conformance: supported AllergyIntolerance

Base System Profile
https://fhir-ig.digital.health.nz/primary-care-acquisition/StructureDefinition/PrimaryCareAllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, create, update, search-type.

Resource Conformance: supported Condition

Base System Profile
PrimaryCareCondition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, create, update, search-type.

Resource Conformance: supported Consent

Base System Profile
PrimaryCareConsent
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, create, update, search-type.

Resource Conformance: supported Encounter

Base System Profile
PrimaryCareEncounter
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, create, update, search-type.

Resource Conformance: supported Observation

Base System Profile
PrimaryCareObservationSmokingStatus
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, create, update, search-type.