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

Resource Profile: RheumaticFeverCarePlan - Detailed Descriptions

Draft as of 2024-08-08

Definitions for the nz-rheumaticfever-careplan resource profile.

Guidance on how to interpret the contents of this table can be found here

0. CarePlan
InvariantsRFCarePlanNZCategoryConstraint: 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())
2. CarePlan.meta
InvariantsRFNZTagConstraint: All instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG) (tag.code contains 'rf-nz')
4. CarePlan.implicitRules
Control0..0
6. CarePlan.language
Control0..0
8. CarePlan.extension
SlicingThis element introduces a set of slices on CarePlan.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 10. CarePlan.extension:statusChange
    Slice NamestatusChange
    ShortAccumulates a history of status changes in the care plan
    Control0..*
    TypeExtension(Care Plan status change history) (Complex Extension)
    12. CarePlan.extension:lifelongSecondaryProphylaxis
    Slice NamelifelongSecondaryProphylaxis
    ShortIndicates that a rheumatic fever patient has been recommended lifelong prophylaxis
    Control0..1
    TypeExtension(Lifelong secondary prophylaxis recommended?) (Extension Type: boolean)
    14. CarePlan.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    SlicingThis element introduces a set of slices on CarePlan.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ use
    • 16. CarePlan.identifier:NHI
      Slice NameNHI
      ShortThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      18. CarePlan.identifier:NHI.id
      Control0..0
      20. CarePlan.identifier:NHI.extension
      Control0..0
      22. CarePlan.identifier:NHI.use
      Control1..?
      BindingThe codes SHALL be taken from Valid use values for NHI
      (required to https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code)
      Pattern Valueofficial
      24. CarePlan.identifier:NHI.system
      Control1..?
      Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
      26. CarePlan.identifier:NHI.value
      Control1..?
      Example<br/><b>National Health Index</b>:ZKC7284
      28. CarePlan.identifier:NationalSystem
      Slice NameNationalSystem
      ShortThis slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS (Salesforce)
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      30. CarePlan.identifier:NationalSystem.id
      Control0..0
      32. CarePlan.identifier:NationalSystem.extension
      Control0..0
      34. CarePlan.identifier:NationalSystem.use
      Control1..?
      Pattern Valueusual
      36. CarePlan.identifier:NationalSystem.type
      Control1..?
      BindingThe codes SHALL be taken from External identifier type codes
      (required to https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code)
      38. CarePlan.identifier:NationalSystem.system
      Example<br/><b>&quot;&quot;&quot;&quot;</b>:https://standards.digital.health.nz/ns/rfccs
      40. CarePlan.identifier:NationalSystem.value
      Control1..?
      Example<br/><b>RFCCS Salesforce CarePlan object id</b>:CTM-0000144
      42. CarePlan.instantiatesCanonical
      Typecanonical(PlanDefinition)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      44. CarePlan.category
      Control1..?
      46. CarePlan.title
      Control1..?
      48. CarePlan.subject
      ShortMust be a reference to Patient instance using the rheumatic fever profile
      TypeReference(Rheumatic Fever Patient)
      50. CarePlan.period
      ShortPeriod start | end must be dateTime values in UTC timezone on the FHIR representation
      Control1..?
      52. CarePlan.created
      ShortCreated must be a dateTime value in UTC timezone on the FHIR representation
      54. CarePlan.author
      Control1..?
      TypeReference(Practitioner, Organization)
      56. CarePlan.addresses
      ShortMust be a reference to Condition instance using the rheumatic fever profile
      TypeReference(Rheumatic Fever Condition)
      58. CarePlan.activity
      60. CarePlan.activity.modifierExtension
      Control0..0
      62. CarePlan.activity.reference
      ShortThe types of activity resources that can be linked in a rheumatic fever careplan are presently limited.
      TypeReference(Rheumatic Fever Medication Request, Appointment)
      64. CarePlan.activity.detail
      Control0..0