Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions
Roadmap
Placeholder
This is the landing page when entering the URL of an IG or following a link to the IG. This page should contain
- A clear high level description of the implementation, including:
- The name of the system
- Who created
- What it’s for
- Who is expected to use it
- What data is involved at a high level
- What FHIR resources are used (unless this is a large list e.g. the IPS, then this detail should be left to another page)
- A description of the tabs/other pages available in the IG
- Contact details for responsible parties
- [Developer experience breadcrumb/directions- approach tbc]
For more information and examples please refer to:
Outstanding Tasks
- Determine whether to continue to use the FHIR IG Publisher or migrate this content to Simplifier
- Move this content to a more appropriate source repository - it’s currently located at https://github.com/tewhatuora/cinc-fhir-ig
- Note: if we want to continue using the IG Auto-Builder then the content needs to be in a public GitHub repository
- Determine where the IG will be published and potentially follow the steps in Publishing an IG and Maintaining an IG Publication to publish it
- Provide content for all of the placeholder sections in this IG
- Potentially provide an additional ‘Developer Guide’ section detailing authentication/authorisation requirements, the Request-Context header, our well-known identifiers, etc
- Potentially add further constraints to our resource profiles:
- Additional mandatory fields
- ValueSets and bindings for coded fields
- Investigate whether we want to publish the IG-generated OpenAPI specification or the OpenAPI specification we generated ourselves which includes our environment details, security requirements, custom headers, etc
- Determine whether to include the Postman Collection in the IG
- Investigate how best to document the
$apply operation - it’s not included in the generated OpenAPI specification or API page by default
- Address the remaining issues in the QA Report
