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 2025-10-02 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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: RFCarePlanNZCategoryConstraint
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
.... extension: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

Path Status Usage ValueSet Version Source
CarePlan.identifier:NHI.​use Base required Valid use values for NHI 📦1.0.0 HL7® FHIR® New Zealand Base Implementation Guide vnull
CarePlan.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CarePlan.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: RFCarePlanNZCategoryConstraint
... meta C 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules 0..0
... language 0..0
.... extension: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
.... extension: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)

Path Status Usage ValueSet Version Source
CarePlan.identifier:NHI.​use Base required Valid use values for NHI 📦1.0.0 HL7® FHIR® New Zealand Base Implementation Guide vnull
CarePlan.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
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'
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: RFCarePlanNZCategoryConstraint
... id Σ 0..1 id Logical id of this artifact
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
.... extension: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
Constraints: cpl-3
.... 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

Path Status Usage ValueSet Version Source
CarePlan.identifier:NHI.​use Base required Valid use values for NHI 📦1.0.0 HL7® FHIR® New Zealand Base Implementation Guide vnull
CarePlan.identifier:NHI.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CarePlan.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CarePlan.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: RFCarePlanNZCategoryConstraint
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
.... extension: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

Path Status Usage ValueSet Version Source
CarePlan.identifier:NHI.​use Base required Valid use values for NHI 📦1.0.0 HL7® FHIR® New Zealand Base Implementation Guide vnull
CarePlan.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CarePlan.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: RFCarePlanNZCategoryConstraint
... meta C 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules 0..0
... language 0..0
.... extension: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
.... extension: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)

Path Status Usage ValueSet Version Source
CarePlan.identifier:NHI.​use Base required Valid use values for NHI 📦1.0.0 HL7® FHIR® New Zealand Base Implementation Guide vnull
CarePlan.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
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'

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan C 0..* CarePlan Healthcare plan for patient or group
Constraints: RFCarePlanNZCategoryConstraint
... id Σ 0..1 id Logical id of this artifact
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension: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
.... extension: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
Constraints: cpl-3
.... 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

Path Status Usage ValueSet Version Source
CarePlan.identifier:NHI.​use Base required Valid use values for NHI 📦1.0.0 HL7® FHIR® New Zealand Base Implementation Guide vnull
CarePlan.identifier:NHI.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CarePlan.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CarePlan.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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'
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron