Te Whatu Ora Shared Care FHIR API
0.3.9 - release New Zealand flag

Te Whatu Ora Shared Care FHIR API - Local Development build (v0.3.9) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: RheumaticFeverCarePlan - Detailed Descriptions

Active as of 2024-06-20

Definitions for the nz-sharedcare-rheumaticfever-careplan resource profile.

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

0. CarePlan
2. CarePlan.implicitRules
Control0..0
4. CarePlan.language
Control0..0
6. 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
  • 8. CarePlan.extension:onHoldReason
    Slice NameonHoldReason
    Control0..1
    TypeExtension(Reason rheumatic fever care plan changed to on-hold status) (Extension Type: string)
    10. CarePlan.extension:closureReason
    Slice NameclosureReason
    Control0..1
    TypeExtension(Reason a rheumatic fever care plan was closed (#revoked status)) (Extension Type: string)
    12. 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
    • 14. 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
      16. CarePlan.identifier:NHI.id
      Control0..0
      18. CarePlan.identifier:NHI.extension
      Control0..0
      20. 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
      22. CarePlan.identifier:NHI.system
      Control1..?
      Fixed Valuehttps://standards.digital.health.nz/ns/nhi-id
      24. CarePlan.identifier:NHI.value
      Control1..?
      Example<br/><b>National Health Index</b>:SCF7824
      26. 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..*
      28. CarePlan.identifier:NationalSystem.id
      Control0..0
      30. CarePlan.identifier:NationalSystem.extension
      Control0..0
      32. CarePlan.identifier:NationalSystem.use
      Control1..?
      Pattern Valueusual
      34. CarePlan.identifier:NationalSystem.type
      Control1..?
      BindingThe codes SHALL be taken from External identifier type codes
      (required to https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/external-system-identifier-type-code)
      36. CarePlan.identifier:NationalSystem.system
      Example<br/><b>General</b>:Uri that defines the type of external identifier
      38. CarePlan.identifier:NationalSystem.value
      Control1..?
      Example<br/><b>Some Salesforce CarePlan object id</b>:CTM-0000144
      40. CarePlan.instantiatesCanonical
      Typecanonical(PlanDefinition)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      42. CarePlan.category
      Control1..1
      BindingThe codes SHALL be taken from Rheumatic fever care plan category codes
      (required to https://fhir-ig-uat.digital.health.nz/shared-care/ValueSet/rf-careplan-category-code)
      44. CarePlan.title
      Control1..?
      46. CarePlan.subject
      TypeReference(Rheumatic Fever Patient)
      48. CarePlan.period
      ShortStart | end values must be in UTC timezone on the FHIR server
      Control1..?
      50. CarePlan.author
      Control1..?
      TypeReference(Practitioner, Organization)
      52. CarePlan.addresses
      TypeReference(Rheumatic Fever Condition)
      54. CarePlan.activity
      56. CarePlan.activity.modifierExtension
      Control0..0
      58. CarePlan.activity.reference
      TypeReference(MedicationRequest, Appointment)
      60. CarePlan.activity.detail
      Control0..0