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

CapabilityStatement: Central Region Integration Hub Capabilities

Official URL: https://fhir-ig.digital.health.nz/crih/CapabilityStatement/nzcr-SmileCDR Version: 1.0.12-rc1
Active as of 2023-11-23 Computable Name: CentralRegionIntegrationHub

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement nzcr-SmileCDR

Central Region Integration Hub

  • Implementation Guide Version: 1.0.12-rc1
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl
  • Supported Patch Formats: application/fhir+json, application/fhir+xml, application/json-patch+json, application/xml-patch+xml
  • Published on: 2023-11-23 01:55:44+0000
  • Published by: Te Whatu Ora, Te Pae Hauora o Ruahine o Tararua, MidCentral

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:
Summary of System-wide Interactions
  • Supports the transactioninteraction.
  • Supports the history-systeminteraction.

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 TypeProfileRV-RSUPCH-IH-TSearches_include_revincludeOperations
AllergyIntolerancehttp://hl7.org/fhir/StructureDefinition/AllergyIntolerance
Additional supported profiles:
  https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionAllergyIntolerance		yyidentifier, _id$validate, $meta, $diff
ClinicalImpressionhttp://hl7.org/fhir/StructureDefinition/ClinicalImpression
Additional supported profiles:
  https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionClinicalImpression		yyidentifier, _id$validate, $meta, $diff
CodeSystemhttp://hl7.org/fhir/StructureDefinition/CodeSystemyyidentifier, _id$meta, $diff
ConceptMaphttp://hl7.org/fhir/StructureDefinition/ConceptMapyyidentifier, _id$validate, $meta, $translate, $diff
Flaghttp://hl7.org/fhir/StructureDefinition/Flag
Additional supported profiles:
  https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionFlag		yyidentifier, _id$validate, $meta, $diff
ImplementationGuidehttp://hl7.org/fhir/StructureDefinition/ImplementationGuideyy_id$validate, $meta, $diff
Organizationhttp://hl7.org/fhir/StructureDefinition/Organizationyyidentifier, _id$validate, $meta, $diff
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles:
  https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionPatient		yyidentifier, _id*, Patient:general-practitioner, Patient:link, Patient:organizationAllergyIntolerance: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$validate, $meta, $diff
Practitionerhttp://hl7.org/fhir/StructureDefinition/Practitioner
Additional supported profiles:
  https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionPractitioner		yy_id$validate, $meta, $diff
ServiceRequesthttp://hl7.org/fhir/StructureDefinition/ServiceRequestyyidentifier, _id, clinicType, referringPractice, consultingPractitioner$validate, $meta, $diff
StructureDefinitionhttp://hl7.org/fhir/StructureDefinition/StructureDefinitionyyyyy_id$meta, $diff
Subscriptionhttp://hl7.org/fhir/StructureDefinition/Subscriptionyyyyyyyy_id$validate, $meta-delete, $meta-add, $meta, $expunge, $diff, $trigger-subscription
ValueSethttp://hl7.org/fhir/StructureDefinition/ValueSetyyyyyidentifier, _id$validate, $meta, $diff

Resource Conformance: supported AllergyIntolerance

Base System Profile
AllergyIntolerance
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionAllergyIntolerance

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Multiple Resources

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported ClinicalImpression

Base System Profile
ClinicalImpression
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionClinicalImpression

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Business identifier

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported CodeSystem

Base System Profile
CodeSystem
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Multiple Resources

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$meta

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

SHALL$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.

Resource Conformance: supported ConceptMap

Base System Profile
ConceptMap
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Multiple Resources

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$translate
SHALL$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.

Resource Conformance: supported Flag

Base System Profile
Flag
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionFlag

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Business identifier

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported ImplementationGuide

Base System Profile
ImplementationGuide
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported Organization

Base System Profile
Organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionPatient

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A patient identifier

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported Practitioner

Base System Profile
Practitioner
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://fhir.org.nz/ig/tewhatuora/crih-fhir-ig/StructureDefinition/NZCentralRegionPractitioner

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported ServiceRequest

Base System Profile
ServiceRequest
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Multiple Resources

SHALL_idtoken

The ID of the resource

SHALLclinicTypetoken

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

SHALLreferringPracticereference

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

SHALLconsultingPractitionerreference

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

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Resource Conformance: supported StructureDefinition

Base System Profile
StructureDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, vread, read, history-type, history-instance.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$meta

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

SHALL$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.

Resource Conformance: supported Subscription

Base System Profile
Subscription
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, update, vread, read, patch, history-type, history-instance, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta-delete

Delete tags, profiles, and/or security labels from a resource

SHALL$meta-add

Add tags, profiles, and/or security labels to a resource

SHALL$meta

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

SHALL$expunge
SHALL$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.

SHALL$trigger-subscription

Triggers the Subscription as if the resources returned by the given searchUrl paratmeter had triggered the Subscription. details Only available on test-smileCDR.mdhb.health.nz instance.

Resource Conformance: supported ValueSet

Base System Profile
ValueSet
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, vread, read, history-type, history-instance.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Multiple Resources

SHALL_idtoken

The ID of the resource

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$meta

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

SHALL$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.

Operations

Use