New Zealand Rheumatic Fever FHIR Implementation Guide
1.0.0 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/fhir-rheumatic-fever/ and changes regularly. See the Directory of published versions
The Rheumatic Fever FHIR API makes uses of the following terminology systems:
snomed.info/sct
)nzmt.org.nz
)There is a substantial amount of clinical terminology in use in New Zealand rheumatic fever care and treatment which is not defined in the SNOMED CT international edition.
To enable this NZ-specific terminology to be practically represented in and interchanged through FHIR, this Implementation Guide defines all NZ-specific terminology using a single common CodeSystem
.
The ValueSets in this IG draw on the single local CodeSystem and in some cases mix in terms from SNOMED CT International Edition, as needed to represent NZ clinical data.
NZ clinicians define rheumatic fever conditions/cases using NZ-specific classifiers in the following categories:
NZ also uses specific clinical terminology in rheumatic fever diagnosis and treatment in the following areas:
Where possible all clinical terminology uses terms from the SNOMED International Edition.
New codings to suit NZ's unique RF requirements have been defined as terms in the New Zealand Edition of SNOMED.
Due to restrictions in public accessibility of SNOMED New Zealand edition terms, this Implementation Guide defines all NZ-specific terminology locally within a single CodeSystem
. Refer to the various ValueSet artefacts which draw on this CodeSystem for the purpose of the various code subsets.
Application developers working with this FHIR API can validate the majority of FHIR resource representations using the IG itself and the default (tx.fhir.org) FHIR terminology service.
Medication resource content using NZMT terminology can be validated against public definitions on the New Zealand Health Terminology Server.
Some FHIR resource types profiled in this IG will contain data originating in the national Rheumatic Fever Care Coordination System (RFCCS). To enable such data to be synchronised between FHIR and the RFCCS system, RFCCS identifiers are stored in FHIR instances of CarePlan, Condition, Observation, etc.
The IG handles these identifiers by slicing the identifier element of the FHIR resource, and allowing a national system identifier coding to be inserted.
Each identifiers from RFCCS or another 'external' national application is represented in RF FHIR resources using
Example a care plan having RFCCS identifier 00073693 is represented in a FHIR CarePlan
as follows:
{.. resource instance content
"identifier" : [
{
"use" : "usual",
"type" : {
"coding" : [
{
"system" : "https://fhir-ig.digital.health.nz/rheumatic-fever/CodeSystem/nz-rheumaticfever-codesystem",
"code" : "rfccs-careplan-id"
}
]
},
"system" : "https://standards.digital.health.nz/ns/rf-ccs-id",
"value" : "00073693"
},
..other identifiers
]
.. instance content continues
}