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 Care Team

Official URL: https://fhir-ig.digital.health.nz/rheumatic-fever/StructureDefinition/nz-rheumaticfever-careteam Version: 1.0.0
Draft as of 2025-10-02 Computable Name: RheumaticFeverCareTeam

Identifies parties involved in secondary prophylaxis (preventative treatment) for a patient. Members typically comprise rheumatic fever service Organizations and Practitioners especially nurses

Controls CareTeam representations to model care teams involved in rheumatic fever secondary prophylaxis (preventative treatment)

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
.. CareTeam C 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
Constraints: CareTeamRFNZCategoryConstraint
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NationalSystem Σ 0..* Identifier This allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 object id: CTM-0000144
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
... category Σ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CareTeam.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base example Care Team category 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
CareTeamRFNZCategoryConstraint error CareTeam All RF CareTeam instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) CareTeam.category.where(coding.code='rf-nz').exists()
RFNZTagConstraint error CareTeam.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 CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CareTeam 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 CareTeam 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 CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam 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 CareTeam

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam C 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
Constraints: CareTeamRFNZCategoryConstraint
... meta C 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... Slices for identifier 0..* Identifier External Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..* Identifier This allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 object id: CTM-0000144
... category 1..* CodeableConcept Type of team

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CareTeam.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
CareTeamRFNZCategoryConstraint error CareTeam All RF CareTeam instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) CareTeam.category.where(coding.code='rf-nz').exists()
RFNZTagConstraint error CareTeam.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
.. CareTeam C 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
Constraints: CareTeamRFNZCategoryConstraint
... id Σ 0..1 id Logical id of this artifact
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier External Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ 0..* Identifier This allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 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)
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
... category Σ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.
... name Σ 0..1 string Name of the team, such as crisis assessment team
... subject Σ 0..1 Reference(Patient | Group) Who care team is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period Σ 0..1 Period Time period team covers
... participant C 0..* BackboneElement Members of the team
Constraints: ctm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 0..* CodeableConcept Type of involvement
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
.... member Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) Who is involved
.... onBehalfOf Σ 0..1 Reference(Organization) Organization of the practitioner
.... period 0..1 Period Time period of participant
... reasonCode 0..* CodeableConcept Why the care team exists
Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team.
... reasonReference 0..* Reference(Condition) Why the care team exists
... managingOrganization Σ 0..* Reference(Organization) Organization responsible for the care team
... telecom 0..* ContactPoint A contact detail for the care team (that applies to all members)
... note 0..* Annotation Comments made about the CareTeam

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CareTeam.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CareTeam.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base example Care Team category 📍4.0.1 FHIR Std.
CareTeam.participant.​role Base example Participant Roles 📍4.0.1 FHIR Std.
CareTeam.reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
CareTeamRFNZCategoryConstraint error CareTeam All RF CareTeam instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) CareTeam.category.where(coding.code='rf-nz').exists()
RFNZTagConstraint error CareTeam.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'
ctm-1 error CareTeam.participant CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists()))
dom-2 error CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CareTeam 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 CareTeam 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 CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam 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 CareTeam

Summary

Mandatory: 1 element(3 nested mandatory elements)
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CareTeam.identifier

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam C 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
Constraints: CareTeamRFNZCategoryConstraint
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:NationalSystem Σ 0..* Identifier This allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 object id: CTM-0000144
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
... category Σ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CareTeam.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base example Care Team category 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
CareTeamRFNZCategoryConstraint error CareTeam All RF CareTeam instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) CareTeam.category.where(coding.code='rf-nz').exists()
RFNZTagConstraint error CareTeam.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 CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CareTeam 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 CareTeam 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 CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam 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 CareTeam

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CareTeam C 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
Constraints: CareTeamRFNZCategoryConstraint
... meta C 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... Slices for identifier 0..* Identifier External Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..* Identifier This allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 object id: CTM-0000144
... category 1..* CodeableConcept Type of team

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
CareTeam.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression
CareTeamRFNZCategoryConstraint error CareTeam All RF CareTeam instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) CareTeam.category.where(coding.code='rf-nz').exists()
RFNZTagConstraint error CareTeam.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
.. CareTeam C 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
Constraints: CareTeamRFNZCategoryConstraint
... id Σ 0..1 id Logical id of this artifact
... meta ΣC 0..1 Meta Metadata about the resource
Constraints: RFNZTagConstraint
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier External Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ 0..* Identifier This allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 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)
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.
... category Σ 1..* CodeableConcept Type of team
Binding: CareTeamCategory (example): Indicates the type of care team.
... name Σ 0..1 string Name of the team, such as crisis assessment team
... subject Σ 0..1 Reference(Patient | Group) Who care team is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... period Σ 0..1 Period Time period team covers
... participant C 0..* BackboneElement Members of the team
Constraints: ctm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 0..* CodeableConcept Type of involvement
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
.... member Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam) Who is involved
.... onBehalfOf Σ 0..1 Reference(Organization) Organization of the practitioner
.... period 0..1 Period Time period of participant
... reasonCode 0..* CodeableConcept Why the care team exists
Binding: SNOMEDCTClinicalFindings (example): Indicates the reason for the care team.
... reasonReference 0..* Reference(Condition) Why the care team exists
... managingOrganization Σ 0..* Reference(Organization) Organization responsible for the care team
... telecom 0..* ContactPoint A contact detail for the care team (that applies to all members)
... note 0..* Annotation Comments made about the CareTeam

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CareTeam.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CareTeam.identifier:NationalSystem.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CareTeam.identifier:NationalSystem.​type Base required External identifier type codes 📦1.0.0 This IG
CareTeam.status Base required CareTeamStatus 📍4.0.1 FHIR Std.
CareTeam.category Base example Care Team category 📍4.0.1 FHIR Std.
CareTeam.participant.​role Base example Participant Roles 📍4.0.1 FHIR Std.
CareTeam.reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
CareTeamRFNZCategoryConstraint error CareTeam All RF CareTeam instances shall have a category #rf-nz (NZ rheumatic fever code defined in this IG) CareTeam.category.where(coding.code='rf-nz').exists()
RFNZTagConstraint error CareTeam.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'
ctm-1 error CareTeam.participant CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists()))
dom-2 error CareTeam If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CareTeam 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 CareTeam 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 CareTeam If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CareTeam 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 CareTeam

Summary

Mandatory: 1 element(3 nested mandatory elements)
Prohibited: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of CareTeam.identifier

 

Other representations of profile: CSV, Excel, Schematron