New Zealand Rheumatic Fever FHIR Implementation Guide
0.4.7 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide
0.4.7 - draft
New Zealand Rheumatic Fever FHIR Implementation Guide - Local Development build (v0.4.7) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careplan | Version: 1.0.0 | |||
| Draft as of 2024-08-08 | Computable Name: RheumaticFeverCarePlan | |||
Profiles shared care plans used in NZ for management of rheumatic fever cases with suspected acute rheumatic fever
Profiles a secondary prevention care plan for a NZ rheumatic fever patient
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CarePlan |
C | 0..* | CarePlan | Healthcare plan for patient or group RFCarePlanNZCategoryConstraint: All RF CarePlan instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) |
  meta |
C | 0..1 | Meta | Metadata about the resource RFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) |
| implicitRules |
0..0 | |||
| language |
0..0 | |||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   statusChange |
0..* | (Complex) | Accumulates a history of status changes in the care plan URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-careplan-statusHistory | |
 lifelongSecondaryProphylaxis |
0..1 | boolean | Indicates that a rheumatic fever patient has been recommended lifelong prophylaxis URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/rf-careplan-lifelongSecondaryProphylaxis | |
 Slices for identifier |
1..* | Identifier | External Ids for this plan Slice: Unordered, Open by value:use | |
 identifier:NHI |
1..1 | Identifier | This allows a rheumatic fever careplan to link to the corresponding object in salesforce | |
  id |
0..0 | |||
| extension |
0..0 | |||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Binding: Valid use values for NHI (required) Required Pattern: official | |
| system |
1..1 | uri | The namespace for the identifier value Fixed Value: https://standards.digital.health.nz/ns/nhi-id | |
 value |
1..1 | string | The value that is unique Example National Health Index: ZKC7284 | |
 identifier:NationalSystem |
0..* | Identifier | This slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS (Salesforce) | |
 id |
0..0 | |||
| extension |
0..0 | |||
| use |
1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| type |
1..1 | CodeableConcept | Description of identifier Binding: External identifier type codes (required) | |
| system |
0..1 | uri | The namespace for the identifier value Example """": https://standards.digital.health.nz/ns/rfccs | |
| value |
1..1 | string | The value that is unique Example RFCCS Salesforce CarePlan object id: CTM-0000144 | |
 instantiatesCanonical |
0..* | canonical(PlanDefinition) | Instantiates FHIR protocol or definition | |
| category |
1..* | CodeableConcept | Type of plan | |
| title |
1..1 | string | Human-friendly name for the care plan | |
 subject |
1..1 | Reference(Rheumatic Fever Patient) | Must be a reference to Patient instance using the rheumatic fever profile | |
| period |
1..1 | Period | Period start | end must be dateTime values in UTC timezone on the FHIR representation | |
| created |
0..1 | dateTime | Created must be a dateTime value in UTC timezone on the FHIR representation | |
| author |
1..1 | Reference(Practitioner | Organization) | Who is the designated responsible party | |
| addresses |
0..* | Reference(Rheumatic Fever Condition) | Must be a reference to Condition instance using the rheumatic fever profile | |
 activity |
||||
 modifierExtension |
0..0 | |||
| reference |
0..1 | Reference(Rheumatic Fever Medication Request | Appointment) | The types of activity resources that can be linked in a rheumatic fever careplan are presently limited. | |
 detail |
0..0 | |||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| CarePlan.identifier:NHI.use | required | Pattern: officialhttps://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code | |
| CarePlan.identifier:NationalSystem.type | required | ExternalSystemIdentifierTypeValueSethttps://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-codefrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| RFCarePlanNZCategoryConstraint | error | CarePlan | All RF CarePlan instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) : CarePlan.category.where(coding.code='rf-nz').exists() | |
| RFNZTagConstraint | error | CarePlan.meta | All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) : tag.code contains 'rf-nz' |
Other representations of profile: CSV, Excel, Schematron
