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

Te Whatu Ora Shared Care FHIR API, published by Te Whatu Ora. This guide is not an authorized publication; it is the continuous build for version 0.3.9 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/tewhatuora/cinc-fhir-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Rheumatic Fever CarePlan

Official URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/nz-sharedcare-rheumaticfever-careplan Version: 1.0.0
Active as of 2024-03-22 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

Warning: The IG official Url will be changing

The official Url of this Implementation Guide is expected to change in early 2024.

The Url domain will move to digital.health.nz and the IG will likely be renamed.

Developers of applications that consume this API are advised to make the official Url base configurable in their applications – the base Url is currently https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/


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 0..*CarePlanHealthcare plan for patient or group
... implicitRules 0..0
... language 0..0
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... closureReason 0..1stringReason a rheumatic fever care plan was closed (#revoked status)
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-closure-reason
... Slices for identifier 1..*IdentifierExternal Ids for this plan
Slice: Unordered, Open by value:use
.... identifier:NHI 1..1IdentifierThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
..... id 0..0
..... extension 0..0
..... use 1..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value 1..1stringThe value that is unique
Example National Health Index: SCF7824
.... identifier:NationalSystem 0..*IdentifierThis 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..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system 0..1uriThe namespace for the identifier value
Example General: Uri that defines the type of external identifier
..... value 1..1stringThe value that is unique
Example Some Salesforce CarePlan object id: CTM-0000144
... instantiatesCanonical 0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... category 1..1CodeableConceptType of plan
Binding: Rheumatic fever care plan category codes (required)
... title 1..1stringHuman-friendly name for the care plan
... subject 1..1Reference(Rheumatic Fever Patient)Who the care plan is for
... period C1..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author 1..1Reference(Practitioner | Organization)Who is the designated responsible party
... addresses 0..*Reference(Rheumatic Fever Condition)Health issues this plan addresses
... activity
.... modifierExtension 0..0
.... reference 0..1Reference(MedicationRequest | Appointment)Activity details defined in specific resource
.... 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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CarePlan.categoryrequiredRheumaticFeverCarePlanCategoryValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careplan-category-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... onHoldReason 0..1stringReason rheumatic fever care plan changed to on-hold status
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-onhold-reason
... closureReason 0..1stringReason a rheumatic fever care plan was closed (#revoked status)
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-closure-reason
... Slices for identifier Σ1..*IdentifierExternal Ids for this plan
Slice: Unordered, Open by value:use
.... identifier:NHI Σ1..1IdentifierThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example National Health Index: SCF7824
.... identifier:NationalSystem Σ0..*IdentifierThis slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS (Salesforce)
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Some Salesforce CarePlan object id: CTM-0000144
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... status ?!Σ1..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ1..1CodeableConceptType of plan
Binding: Rheumatic fever care plan category codes (required)
... title Σ1..1stringHuman-friendly name for the care plan
... subject Σ1..1Reference(Rheumatic Fever Patient)Who the care plan is for
... period ΣC1..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author Σ1..1Reference(Practitioner | Organization)Who is the designated responsible party
... addresses Σ0..*Reference(Rheumatic Fever Condition)Health issues this plan addresses

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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/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.categoryrequiredRheumaticFeverCarePlanCategoryValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careplan-category-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... onHoldReason 0..1stringReason rheumatic fever care plan changed to on-hold status
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-onhold-reason
... closureReason 0..1stringReason a rheumatic fever care plan was closed (#revoked status)
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-closure-reason
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..*IdentifierExternal Ids for this plan
Slice: Unordered, Open by value:use
.... identifier:NHI Σ1..1IdentifierThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example National Health Index: SCF7824
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:NationalSystem Σ0..*IdentifierThis slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS (Salesforce)
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Some Salesforce CarePlan object id: CTM-0000144
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates 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..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ1..1CodeableConceptType of plan
Binding: Rheumatic fever care plan category codes (required)
... title Σ1..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Rheumatic Fever Patient)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period ΣC1..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... created Σ0..1dateTimeDate record was first recorded
... author Σ1..1Reference(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)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity C0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference C0..1Reference(MedicationRequest | Appointment)Activity details defined in specific resource
... note 0..*AnnotationComments 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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/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.categoryrequiredRheumaticFeverCarePlanCategoryValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careplan-category-code
from this IG
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
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from CarePlan

Summary

Mandatory: 9 elements (3 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element CarePlan.identifier is sliced based on the value of value:use

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... implicitRules 0..0
... language 0..0
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... closureReason 0..1stringReason a rheumatic fever care plan was closed (#revoked status)
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-closure-reason
... Slices for identifier 1..*IdentifierExternal Ids for this plan
Slice: Unordered, Open by value:use
.... identifier:NHI 1..1IdentifierThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
..... id 0..0
..... extension 0..0
..... use 1..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... system 1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value 1..1stringThe value that is unique
Example National Health Index: SCF7824
.... identifier:NationalSystem 0..*IdentifierThis 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..1codeusual | official | temp | secondary | old (If known)
Required Pattern: usual
..... type 1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system 0..1uriThe namespace for the identifier value
Example General: Uri that defines the type of external identifier
..... value 1..1stringThe value that is unique
Example Some Salesforce CarePlan object id: CTM-0000144
... instantiatesCanonical 0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... category 1..1CodeableConceptType of plan
Binding: Rheumatic fever care plan category codes (required)
... title 1..1stringHuman-friendly name for the care plan
... subject 1..1Reference(Rheumatic Fever Patient)Who the care plan is for
... period C1..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author 1..1Reference(Practitioner | Organization)Who is the designated responsible party
... addresses 0..*Reference(Rheumatic Fever Condition)Health issues this plan addresses
... activity
.... modifierExtension 0..0
.... reference 0..1Reference(MedicationRequest | Appointment)Activity details defined in specific resource
.... 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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CarePlan.categoryrequiredRheumaticFeverCarePlanCategoryValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careplan-category-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... onHoldReason 0..1stringReason rheumatic fever care plan changed to on-hold status
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-onhold-reason
... closureReason 0..1stringReason a rheumatic fever care plan was closed (#revoked status)
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-closure-reason
... Slices for identifier Σ1..*IdentifierExternal Ids for this plan
Slice: Unordered, Open by value:use
.... identifier:NHI Σ1..1IdentifierThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... system Σ1..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example National Health Index: SCF7824
.... identifier:NationalSystem Σ0..*IdentifierThis slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS (Salesforce)
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Some Salesforce CarePlan object id: CTM-0000144
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... status ?!Σ1..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ1..1CodeableConceptType of plan
Binding: Rheumatic fever care plan category codes (required)
... title Σ1..1stringHuman-friendly name for the care plan
... subject Σ1..1Reference(Rheumatic Fever Patient)Who the care plan is for
... period ΣC1..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... author Σ1..1Reference(Practitioner | Organization)Who is the designated responsible party
... addresses Σ0..*Reference(Rheumatic Fever Condition)Health issues this plan addresses

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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/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.categoryrequiredRheumaticFeverCarePlanCategoryValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careplan-category-code
from this IG

Constraints

IdGradePath(s)DetailsRequirements
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare plan for patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... onHoldReason 0..1stringReason rheumatic fever care plan changed to on-hold status
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-onhold-reason
... closureReason 0..1stringReason a rheumatic fever care plan was closed (#revoked status)
URL: https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/StructureDefinition/rf-careplan-closure-reason
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ1..*IdentifierExternal Ids for this plan
Slice: Unordered, Open by value:use
.... identifier:NHI Σ1..1IdentifierThis allows a rheumatic fever careplan to link to the corresponding object in salesforce
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: Valid use values for NHI (required)
Required Pattern: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Fixed Value: https://standards.digital.health.nz/ns/nhi-id
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example National Health Index: SCF7824
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:NationalSystem Σ0..*IdentifierThis slice is for clients to link FHIR RF care plans to corresponding records in national systems eg. RFCCS (Salesforce)
..... extension 0..0
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ1..1CodeableConceptDescription of identifier
Binding: External identifier type codes (required)
..... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example General: Uri that defines the type of external identifier
..... value Σ1..1stringThe value that is unique
Example General: 123456
Example Some Salesforce CarePlan object id: CTM-0000144
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..*canonical(PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates 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..1codedraft | 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..1codeproposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.

... category Σ1..1CodeableConceptType of plan
Binding: Rheumatic fever care plan category codes (required)
... title Σ1..1stringHuman-friendly name for the care plan
... description Σ0..1stringSummary of nature of plan
... subject Σ1..1Reference(Rheumatic Fever Patient)Who the care plan is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period ΣC1..1PeriodTime period plan covers
fhir-hnz-period-utc-1: period start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
... created Σ0..1dateTimeDate record was first recorded
... author Σ1..1Reference(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)Health issues this plan addresses
... supportingInfo 0..*Reference(Resource)Information considered as part of plan
... goal 0..*Reference(Goal)Desired outcome of plan
... activity C0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... outcomeCodeableConcept 0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.


.... outcomeReference 0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress 0..*AnnotationComments about the activity status/progress
.... reference C0..1Reference(MedicationRequest | Appointment)Activity details defined in specific resource
... note 0..*AnnotationComments 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://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/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.categoryrequiredRheumaticFeverCarePlanCategoryValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careplan-category-code
from this IG
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
fhir-hnz-period-utc-1warningCarePlan.periodperiod start and end must be dateTime values in UTC Coordinated Universal Time (not New Zealand time)
: true

This structure is derived from CarePlan

Summary

Mandatory: 9 elements (3 nested mandatory elements)
Fixed Value: 1 element
Prohibited: 8 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element CarePlan.identifier is sliced based on the value of value:use

 

Other representations of profile: CSV, Excel, Schematron