New Zealand Rheumatic Fever FHIR Implementation Guide
1.0.0 - draft
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
| Active as of 2024-09-26 |
{
"resourceType" : "CodeSystem",
"id" : "nz-rheumaticfever-codesystem",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CodeSystem nz-rheumaticfever-codesystem</b></p><a name=\"nz-rheumaticfever-codesystem\"> </a><a name=\"hcnz-rheumaticfever-codesystem\"> </a><a name=\"nz-rheumaticfever-codesystem-en-US\"> </a><p>This case-sensitive code system <code>https://fhir-ig.digital.health.nz/rheumatic-fever/CodeSystem/nz-rheumaticfever-codesystem</code> defines the following codes in an undefined hierarchy:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">meta-tags<a name=\"nz-rheumaticfever-codesystem-meta-tags\"> </a></td><td>meta tags</td><td>These codes are used to tag an instance via its meta.tag element</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rf-nz<a name=\"nz-rheumaticfever-codesystem-rf-nz\"> </a></td><td>rheumatic fever</td><td>General purpose FHIR tag/classifier signifying FHIR information about an NZ rheumatic fever patient/case</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">condition-summary-codes<a name=\"nz-rheumaticfever-codesystem-condition-summary-codes\"> </a></td><td>These codes are used in NZ to summarise the condition diagnosis</td><td>These code values originate in SNOMED CT but are defined only in the SNOMED NZ Edition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0302471000210100<a name=\"nz-rheumaticfever-codesystem-302471000210100\"> </a></td><td>Rheumatic heart disease with absence of signs and symptoms of acute rheumatic fever (situation)</td><td>Can be used to summarise the diagnosis of a patient with a rheumatic fever condition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0299171000210109<a name=\"nz-rheumaticfever-codesystem-299171000210109\"> </a></td><td>History of acute rheumatic fever without heart disease</td><td>Can be used to summarise the diagnosis of a patient with a rheumatic fever condition</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">diagnostic-certainty-codes<a name=\"nz-rheumaticfever-codesystem-diagnostic-certainty-codes\"> </a></td><td>Certainty of diagnosis classifiers</td><td>As rheumatic fever can be difficult to diagnose, these codes provide a way to classify confidence in a particular case diagnosis</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0not-a-case<a name=\"nz-rheumaticfever-codesystem-not-a-case\"> </a></td><td>not a case</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0under-investigation<a name=\"nz-rheumaticfever-codesystem-under-investigation\"> </a></td><td>under investigation</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0borderline<a name=\"nz-rheumaticfever-codesystem-borderline\"> </a></td><td>borderline</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0possible<a name=\"nz-rheumaticfever-codesystem-possible\"> </a></td><td>possible</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0probable<a name=\"nz-rheumaticfever-codesystem-probable\"> </a></td><td>probable</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0definite<a name=\"nz-rheumaticfever-codesystem-definite\"> </a></td><td>definite</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">rhd-severity-special-codes<a name=\"nz-rheumaticfever-codesystem-rhd-severity-special-codes\"> </a></td><td/><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0300171000210106<a name=\"nz-rheumaticfever-codesystem-300171000210106\"> </a></td><td>Trivial (qualifier value)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a059391000119102<a name=\"nz-rheumaticfever-codesystem-59391000119102\"> </a></td><td>History of heart valve repair (situation)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0301561000210102<a name=\"nz-rheumaticfever-codesystem-301561000210102\"> </a></td><td>History of heart valve replacement (situation)</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">diagnosis-evidence-group-codes<a name=\"nz-rheumaticfever-codesystem-diagnosis-evidence-group-codes\"> </a></td><td>Observation diagnosis evidence groupings</td><td>These code values originate in SNOMED CT, two being defined only in the SNOMED NZ Edition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0439238004<a name=\"nz-rheumaticfever-codesystem-439238004\"> </a></td><td>Echocardiography test interpretation (observable entity)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0447541000210107<a name=\"nz-rheumaticfever-codesystem-447541000210107\"> </a></td><td>New Zealand Jones Criteria Assessment (observable entity)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0448011000210101<a name=\"nz-rheumaticfever-codesystem-448011000210101\"> </a></td><td>Evidence of preceding Streptococcus group A infection</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">diagnosis-component-NZ-special-concepts<a name=\"nz-rheumaticfever-codesystem-diagnosis-component-NZ-special-concepts\"> </a></td><td>Special concepts in NZ RF diagnosis</td><td>These code value originate in SNOMED CT, one being defined only in the SNOMED NZ Edition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0448021000210106<a name=\"nz-rheumaticfever-codesystem-448021000210106\"> </a></td><td>Indolent carditis (disorder)</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">NZ-specific-role-codes<a name=\"nz-rheumaticfever-codesystem-NZ-specific-role-codes\"> </a></td><td/><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0320731000210100<a name=\"nz-rheumaticfever-codesystem-320731000210100\"> </a></td><td>Support person</td><td>Role code used in patient whanau care team (RfPatient.contact)</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">NZ-specific-injection-site-codes<a name=\"nz-rheumaticfever-codesystem-NZ-specific-injection-site-codes\"> </a></td><td>Specific injection sites in rheumatic fever secondary prophylaxis</td><td>These code values originate in the SNOMED NZ Edition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0299151000210101<a name=\"nz-rheumaticfever-codesystem-299151000210101\"> </a></td><td>Structure of left ventrogluteal region (body structure)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0299161000210103<a name=\"nz-rheumaticfever-codesystem-299161000210103\"> </a></td><td>Structure of right ventrogluteal region (body structure)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0299121000210105<a name=\"nz-rheumaticfever-codesystem-299121000210105\"> </a></td><td>Structure of left upper outer quadrant of buttock (body structure)</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0299141000210104<a name=\"nz-rheumaticfever-codesystem-299141000210104\"> </a></td><td>Structure of right upper outer quadrant of buttock (body structure)</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">nz-specific-medication-frequency-codes<a name=\"nz-rheumaticfever-codesystem-nz-specific-medication-frequency-codes\"> </a></td><td>Specific medication frequency in rheumatic fever secondary prophylaxis</td><td>This code value originates in the SNOMED NZ Edition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0447521000210101<a name=\"nz-rheumaticfever-codesystem-447521000210101\"> </a></td><td>Every thirteen weeks (qualifier value)</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">nz-specific-medication-allergy-codes<a name=\"nz-rheumaticfever-codesystem-nz-specific-medication-allergy-codes\"> </a></td><td>Specific allergy types relevant to rheumatic fever secondary prophylaxis</td><td>These code values originate in the SNOMED NZ Edition</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0332571000210107<a name=\"nz-rheumaticfever-codesystem-332571000210107\"> </a></td><td>Allergy to benzathine penicillin</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0332581000210109<a name=\"nz-rheumaticfever-codesystem-332581000210109\"> </a></td><td>Allergy to pharmaceutical excipient</td><td/></tr><tr><td>1</td><td style=\"white-space:nowrap\">nz-national-system-identifier-type-codes<a name=\"nz-rheumaticfever-codesystem-nz-national-system-identifier-type-codes\"> </a></td><td>Codes for differentiating types of external identifiers in national system slice of FHIR resource Identifier</td><td>These codes signify identifiers which originate in a national system but synchronised into FHIR. The purpose of designating these codes is to provide a type discriminator for slicing Identifier in FHIR resource profiles</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-careplan-id<a name=\"nz-rheumaticfever-codesystem-rfccs-careplan-id\"> </a></td><td>Identifies a CarePlan (case number) object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-careplanactivity-id<a name=\"nz-rheumaticfever-codesystem-rfccs-careplanactivity-id\"> </a></td><td>Identifies a CarePlanActivity object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-condition-id<a name=\"nz-rheumaticfever-codesystem-rfccs-condition-id\"> </a></td><td>Identifies a patient Condition object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-careteam-id<a name=\"nz-rheumaticfever-codesystem-rfccs-careteam-id\"> </a></td><td>Identifies a CareTeam object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-serviceappointment-id<a name=\"nz-rheumaticfever-codesystem-rfccs-serviceappointment-id\"> </a></td><td>Identifies a patient appointment object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-clinicalencounter-id<a name=\"nz-rheumaticfever-codesystem-rfccs-clinicalencounter-id\"> </a></td><td>Identifies a secondary prophylaxis appointment encounter object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0rfccs-observation-id<a name=\"nz-rheumaticfever-codesystem-rfccs-observation-id\"> </a></td><td>Identifies an observation object in the NZ national RF Care Coordination System</td><td/></tr><tr><td>2</td><td style=\"white-space:nowrap\">\u00a0\u00a0episurv-number<a name=\"nz-rheumaticfever-codesystem-episurv-number\"> </a></td><td>Identifies a notifiable disease surveillance case number in ESR's EpiSurv national system</td><td/></tr></table></div>"
},
"url" : "https://fhir-ig.digital.health.nz/rheumatic-fever/CodeSystem/nz-rheumaticfever-codesystem",
"version" : "1.0.0",
"name" : "NzRheumaticFeverCodeSystem",
"title" : "NZ-specific terminology in rheumatic fever data representation",
"status" : "active",
"experimental" : false,
"date" : "2024-09-26T01:10:25+00:00",
"publisher" : "Te Whatu Ora",
"contact" : [
{
"name" : "Te Whatu Ora",
"telecom" : [
{
"system" : "url",
"value" : "https://www.tewhatuora.govt.nz/"
},
{
"system" : "email",
"value" : "integration@tewhatuora.govt.nz"
}
]
},
{
"name" : "HNZ Integration Team",
"telecom" : [
{
"system" : "email",
"value" : "integration@tewhatuora.govt.nz",
"use" : "work"
}
]
}
],
"description" : "This system defines standard codes used throughout this Implementation Guide for New Zealand rheumatic fever data representation",
"purpose" : "The codes defined in this CodeSystem are used throughout the rheumatic fever IG, including in resource profiles.\n\nOriginally it was sought to define these codes as concepts in the NZ Edition of SNOMED CT. However, this turned out to be unworkable due to \nrestrictions imposed by SNOMED that only 'affiliate members' can access the contents of the SNOMED CT edition. As a consequence of this, applications \ncannot lookup nor access term definitions on NZHTS -- NZ's official terminology server. This prevents FHIR validation of FHIR resources using (or \nmeant to use) NZ edition SNOMED terms/codes.\n\nDue to these restrictions this IG defines codes needed for NZ rheumatic fever data representation locally within the IG, in this CodeSystem. \nSome of these codes re-use the original code numbers assigned in the NZ SNOMED edition in case this becomes publically accessible in future.\nThe codes here are arranged in a 2-layer hierarchy which enables ValueSets segregated by purpose and help consumers understand the various purposes of the codes.",
"caseSensitive" : true,
"content" : "complete",
"count" : 43,
"concept" : [
{
"code" : "meta-tags",
"display" : "meta tags",
"definition" : "These codes are used to tag an instance via its meta.tag element",
"concept" : [
{
"code" : "rf-nz",
"display" : "rheumatic fever",
"definition" : "General purpose FHIR tag/classifier signifying FHIR information about an NZ rheumatic fever patient/case"
}
]
},
{
"code" : "condition-summary-codes",
"display" : "These codes are used in NZ to summarise the condition diagnosis",
"definition" : "These code values originate in SNOMED CT but are defined only in the SNOMED NZ Edition",
"concept" : [
{
"code" : "302471000210100",
"display" : "Rheumatic heart disease with absence of signs and symptoms of acute rheumatic fever (situation)",
"definition" : "Can be used to summarise the diagnosis of a patient with a rheumatic fever condition"
},
{
"code" : "299171000210109",
"display" : "History of acute rheumatic fever without heart disease",
"definition" : "Can be used to summarise the diagnosis of a patient with a rheumatic fever condition"
}
]
},
{
"code" : "diagnostic-certainty-codes",
"display" : "Certainty of diagnosis classifiers",
"definition" : "As rheumatic fever can be difficult to diagnose, these codes provide a way to classify confidence in a particular case diagnosis",
"concept" : [
{
"code" : "not-a-case",
"display" : "not a case"
},
{
"code" : "under-investigation",
"display" : "under investigation"
},
{
"code" : "borderline",
"display" : "borderline"
},
{
"code" : "possible",
"display" : "possible"
},
{
"code" : "probable",
"display" : "probable"
},
{
"code" : "definite",
"display" : "definite"
}
]
},
{
"code" : "rhd-severity-special-codes",
"concept" : [
{
"code" : "300171000210106",
"display" : "Trivial (qualifier value)"
},
{
"code" : "59391000119102",
"display" : "History of heart valve repair (situation)"
},
{
"code" : "301561000210102",
"display" : "History of heart valve replacement (situation)"
}
]
},
{
"code" : "diagnosis-evidence-group-codes",
"display" : "Observation diagnosis evidence groupings",
"definition" : "These code values originate in SNOMED CT, two being defined only in the SNOMED NZ Edition",
"concept" : [
{
"code" : "439238004",
"display" : "Echocardiography test interpretation (observable entity)"
},
{
"code" : "447541000210107",
"display" : "New Zealand Jones Criteria Assessment (observable entity)"
},
{
"code" : "448011000210101",
"display" : "Evidence of preceding Streptococcus group A infection"
}
]
},
{
"code" : "diagnosis-component-NZ-special-concepts",
"display" : "Special concepts in NZ RF diagnosis",
"definition" : "These code value originate in SNOMED CT, one being defined only in the SNOMED NZ Edition",
"concept" : [
{
"code" : "448021000210106",
"display" : "Indolent carditis (disorder)"
}
]
},
{
"code" : "NZ-specific-role-codes",
"concept" : [
{
"code" : "320731000210100",
"display" : "Support person",
"definition" : "Role code used in patient whanau care team (RfPatient.contact)"
}
]
},
{
"code" : "NZ-specific-injection-site-codes",
"display" : "Specific injection sites in rheumatic fever secondary prophylaxis",
"definition" : "These code values originate in the SNOMED NZ Edition",
"concept" : [
{
"code" : "299151000210101",
"display" : "Structure of left ventrogluteal region (body structure)"
},
{
"code" : "299161000210103",
"display" : "Structure of right ventrogluteal region (body structure)"
},
{
"code" : "299121000210105",
"display" : "Structure of left upper outer quadrant of buttock (body structure)"
},
{
"code" : "299141000210104",
"display" : "Structure of right upper outer quadrant of buttock (body structure)"
}
]
},
{
"code" : "nz-specific-medication-frequency-codes",
"display" : "Specific medication frequency in rheumatic fever secondary prophylaxis",
"definition" : "This code value originates in the SNOMED NZ Edition",
"concept" : [
{
"code" : "447521000210101",
"display" : "Every thirteen weeks (qualifier value)"
}
]
},
{
"code" : "nz-specific-medication-allergy-codes",
"display" : "Specific allergy types relevant to rheumatic fever secondary prophylaxis",
"definition" : "These code values originate in the SNOMED NZ Edition",
"concept" : [
{
"code" : "332571000210107",
"display" : "Allergy to benzathine penicillin"
},
{
"code" : "332581000210109",
"display" : "Allergy to pharmaceutical excipient"
}
]
},
{
"code" : "nz-national-system-identifier-type-codes",
"display" : "Codes for differentiating types of external identifiers in national system slice of FHIR resource Identifier",
"definition" : "These codes signify identifiers which originate in a national system but synchronised into FHIR. The purpose of designating these codes is to provide a type discriminator for slicing Identifier in FHIR resource profiles",
"concept" : [
{
"code" : "rfccs-careplan-id",
"display" : "Identifies a CarePlan (case number) object in the NZ national RF Care Coordination System"
},
{
"code" : "rfccs-careplanactivity-id",
"display" : "Identifies a CarePlanActivity object in the NZ national RF Care Coordination System"
},
{
"code" : "rfccs-condition-id",
"display" : "Identifies a patient Condition object in the NZ national RF Care Coordination System"
},
{
"code" : "rfccs-careteam-id",
"display" : "Identifies a CareTeam object in the NZ national RF Care Coordination System"
},
{
"code" : "rfccs-serviceappointment-id",
"display" : "Identifies a patient appointment object in the NZ national RF Care Coordination System"
},
{
"code" : "rfccs-clinicalencounter-id",
"display" : "Identifies a secondary prophylaxis appointment encounter object in the NZ national RF Care Coordination System"
},
{
"code" : "rfccs-observation-id",
"display" : "Identifies an observation object in the NZ national RF Care Coordination System"
},
{
"code" : "episurv-number",
"display" : "Identifies a notifiable disease surveillance case number in ESR's EpiSurv national system"
}
]
}
]
}