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

Resource Profile: Rheumatic Fever CarePlan

Official URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careplan Version: 1.0.0
Draft as of 2024-09-26 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:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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 RFCCS
..... 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
..... 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 uri: https://standards.digital.health.nz/ns/rfccs
..... value 1..1 string The value that is unique
Example RFCCS 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
CarePlan.identifier:NHI.userequiredPattern: official
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
CarePlan.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
RFCarePlanNZCategoryConstrainterrorCarePlanAll 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()
RFNZTagConstrainterrorCarePlan.metaAll instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG)
: tag.code contains 'rf-nz'
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NHI Σ 1..1 Identifier This allows a rheumatic fever careplan to link to the corresponding object in RFCCS
..... 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 General: 123456
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
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, 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 General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS CarePlan object id: CTM-0000144
... instantiatesCanonical Σ 0..* canonical(PlanDefinition) Instantiates FHIR protocol or definition
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ 1..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.


... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.identifier:NHI.userequiredPattern: official
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
CarePlan.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CarePlan.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
RFCarePlanNZCategoryConstrainterrorCarePlanAll 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()
RFNZTagConstrainterrorCarePlan.metaAll instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG)
: tag.code contains 'rf-nz'
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
... id Σ 0..1 id Logical id of this artifact
... 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)
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 RFCCS
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... 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 General: 123456
Example National Health Index: ZKC7284
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NationalSystem Σ 0..* Identifier This slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, 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 General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS CarePlan object id: CTM-0000144
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ 1..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.


... title Σ 1..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... 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
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(CareTeam) Who's involved in plan?
... addresses Σ 0..* Reference(Rheumatic Fever Condition) Must be a reference to Condition instance using the rheumatic fever profile
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity C 0..* BackboneElement Action to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference C 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.
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.identifier:NHI.userequiredPattern: official
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
CarePlan.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CarePlan.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CarePlan.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
RFCarePlanNZCategoryConstrainterrorCarePlanAll 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()
RFNZTagConstrainterrorCarePlan.metaAll instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG)
: tag.code contains 'rf-nz'

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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 RFCCS
..... 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
..... 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 uri: https://standards.digital.health.nz/ns/rfccs
..... value 1..1 string The value that is unique
Example RFCCS 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

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
CarePlan.identifier:NHI.userequiredPattern: official
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
CarePlan.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
RFCarePlanNZCategoryConstrainterrorCarePlanAll 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()
RFNZTagConstrainterrorCarePlan.metaAll instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG)
: tag.code contains 'rf-nz'

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NHI Σ 1..1 Identifier This allows a rheumatic fever careplan to link to the corresponding object in RFCCS
..... 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 General: 123456
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
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, 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 General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS CarePlan object id: CTM-0000144
... instantiatesCanonical Σ 0..* canonical(PlanDefinition) Instantiates FHIR protocol or definition
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ 1..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.


... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.identifier:NHI.userequiredPattern: official
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
CarePlan.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CarePlan.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
RFCarePlanNZCategoryConstrainterrorCarePlanAll 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()
RFNZTagConstrainterrorCarePlan.metaAll instances shall have an #rf-nz meta.tag (the NZ rheumatic fever generic code defined in this IG)
: tag.code contains 'rf-nz'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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)
... id Σ 0..1 id Logical id of this artifact
... 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)
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 RFCCS
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... 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 General: 123456
Example National Health Index: ZKC7284
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:NationalSystem Σ 0..* Identifier This slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS
..... extension 0..0
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, 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 General: http://www.acme.com/identifiers/patient
Example uri: https://standards.digital.health.nz/ns/rfccs
..... value Σ 1..1 string The value that is unique
Example General: 123456
Example RFCCS CarePlan object id: CTM-0000144
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... instantiatesCanonical Σ 0..* canonical(PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn Σ 0..* Reference(CarePlan) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ 1..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.


... title Σ 1..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Rheumatic Fever Patient) Must be a reference to Patient instance using the rheumatic fever profile
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... 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
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(CareTeam) Who's involved in plan?
... addresses Σ 0..* Reference(Rheumatic Fever Condition) Must be a reference to Condition instance using the rheumatic fever profile
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity C 0..* BackboneElement Action to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference C 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.
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.identifier:NHI.userequiredPattern: official
https://nzhts.digital.health.nz/fhir/ValueSet/nhi-use-code
CarePlan.identifier:NHI.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CarePlan.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CarePlan.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://fhir-ig.digital.health.nz/rheumatic-fever/ValueSet/external-system-identifier-type-code
from this IG
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
from the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
from the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
from the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
RFCarePlanNZCategoryConstrainterrorCarePlanAll 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()
RFNZTagConstrainterrorCarePlan.metaAll 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