Well Child Tamariki Ora FHIR Implementation Guide
0.1.0 - release New Zealand flag

Well Child Tamariki Ora FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

B4SC APIs

B4SC API Services

Proposed logical interfaces only. Paths, request schemas, ownership and security controls require approval. These services support the B4SC workflow.

Schedule API

Exposes due children, assigned providers and progress to authorised Coordinator and PMS/EMR consumers. The Scheduler/orchestrator, not the Schedule API itself, manages CarePlan and Task lifecycle.

An authorised Coordinator or PMS/EMR requests a time-limited link for a particular child, Task and Questionnaire. Links are not automatically created with every CarePlan.

Summary API

Generates or retrieves clinical and whānau summaries from approved evidence. Summary availability does not itself close the CarePlan; required referral outcomes may remain outstanding.

Common requirements

Authentication, authorisation, correlation IDs, audit, retries, idempotency, privacy controls and error handling must be specified in approved API contracts. See Developer Guide and Open Decisions.

National service dependencies

Use the authoritative NHI, NES, HPI and AIR specifications. Validate URLs and approved versions before publishing.