Te Whatu Ora, Central Region Integration Hub
1.0.12-rc1 - ci-build New Zealand flag

Te Whatu Ora, Central Region Integration Hub, published by Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral. This guide is not an authorized publication; it is the continuous build for version 1.0.12-rc1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/centralRegion-integrationHub-ig/ and changes regularly. See the Directory of published versions

Clinical Resources

API Summary (Generated from the CapabilityStatement: nzcr-SmileCDR)

Central Region Integration Hub

  • Implementation Guide Version: 1.0.12-rc1
  • FHIR Version: 4.0.1
  • Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl
  • Patch Formats: application/fhir+json, application/fhir+xml, application/json-patch+json, application/xml-patch+xml
  • Published On: 2023-11-23T01:55:44.321+00:00
  • Published By: Te Whatu Ora, Te Pae Ora o Ruahine o Tararua - Health NZ, Mid-Central
Note: Complete documentation on FHIR REST operations is available at FHIR RESTful API

Capabilities by Resource/Profile:
Resouce TypeProfileOperationsSearches_incldue_revinclude
AllergyIntolerance Local Profile:
NZCentralRegionAllergyIntolerance
search-type, read identifier, _id
ClinicalImpression Local Profile:
NZCentralRegionClinicalImpression
search-type, read identifier, _id
Flag Local Profile:
NZCentralRegionFlag
search-type, read identifier, _id
Organization Base System Profile:
http://hl7.org/fhir/StructureDefinition/Organization
search-type, read identifier, _id
Patient Local Profile:
NZCentralRegionPatient
search-type, read identifier, _id *, Patient:general-practitioner, Patient:link, Patient:organization AllergyIntolerance:asserter, AllergyIntolerance:patient, AllergyIntolerance:recorder, ClinicalImpression:patient, ClinicalImpression:subject, ClinicalImpression:supporting-info, Flag:author, Flag:patient, Flag:subject, Patient:link, ServiceRequest:patient, ServiceRequest:performer, ServiceRequest:requester, ServiceRequest:subject
Practitioner Local Profile:
NZCentralRegionPractitioner
search-type, read _id
ServiceRequest Base System Profile:
http://hl7.org/fhir/StructureDefinition/ServiceRequest
search-type, read identifier, _id, clinicType, referringPractice, consultingPractitioner

AllergyIntolerance


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
identifier token
_id token

The ID of the resource


ClinicalImpression


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
identifier token
_id token

The ID of the resource


Flag


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
identifier token
_id token

The ID of the resource


Organization


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
identifier token
_id token

The ID of the resource


Patient


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
identifier token
_id token

The ID of the resource


Search includes:
Name
*
Patient:general-practitioner
Patient:link
Patient:organization

These are the _include parameters that are supported on searches

Practitioner


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
_id token

The ID of the resource


ServiceRequest


Interactions:
InteractionDocumentation
search-type

Queries against the resource type. Will return a Bundle (even if there are no matching resources). The search-type interaction is performed by an HTTP GET command - [base]/[resource-type]/_search

read

Retrieves a resource by its ID. Will return a single resource. The read interaction accesses the current contents of a resource. The interaction is performed by an HTTP GET command


Extended Operations
OperationDocumentation
$validate

Checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. details - [base]/[Resource]/[id]/$validate

$meta

Request a list of tags, profiles, and security labels for a specfic resource instance

$diff

Examines two resource versions (can be two versions of the same resource, or two different resources) and generates a FHIR Patch document showing the differences.


Search Parameters:
NameTypeDocumentation
identifier token
_id token

The ID of the resource

clinicType token
Definition: https://standards.digital.health.nz/fhir/central-region/SearchParam-nzcr-referral-clinic-type

This SearchParameter enables query of referral flavour of ServiceRequest by clinicType to support Subscribers receiving notifcations off a subset of referrals.

referringPractice reference
Definition: https://standards.digital.health.nz/fhir/central-region/SearchParam-nzcr-referral-referring-practice

This SearchParameter enables query of referral flavour of ServiceRequest by referringPractice to support Subscribers receiving notifcations that include the referringPractice's Organization resource

consultingPractitioner reference
Definition: https://standards.digital.health.nz/fhir/central-region/SearchParam-nzcr-referral-consulting-practitioner

This SearchParameter enables query of referral flavour of ServiceRequest by consultingPractitioner to support Subscribers receiving notifcations that include the consultingPractitioner's Practitioner resource