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

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

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 CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... Slices for identifier 0..*IdentifierExternal Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..*IdentifierThis allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 Salesforce object id: CTM-0000144
... category 1..1CodeableConceptType of team
Binding: Rheumatic fever care team category codes (required)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 320741000210108
..... display1..1stringRepresentation defined by the system
Fixed Value: Secondary prophylaxis team

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
CareTeam.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CareTeam.categoryrequiredPattern: SNOMED CT code 320741000210108("Secondary prophylaxis team")
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careteam-category-code
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 Salesforce object id: CTM-0000144
... category Σ1..1CodeableConceptType of team
Binding: Rheumatic fever care team category codes (required)

Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 320741000210108
..... display1..1stringRepresentation defined by the system
Fixed Value: Secondary prophylaxis team

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CareTeam.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryrequiredPattern: SNOMED CT code 320741000210108("Secondary prophylaxis team")
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careteam-category-code
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 Salesforce 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)
... status ?!Σ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category Σ1..1CodeableConceptType of team
Binding: Rheumatic fever care team category codes (required)

Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 320741000210108
..... display1..1stringRepresentation defined by the system
Fixed Value: Secondary prophylaxis team
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... name Σ0..1stringName of the team, such as crisis assessment team
... subject Σ0..1Reference(Patient | Group)Who care team is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period team covers
... participant C0..*BackboneElementMembers of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ0..*CodeableConceptType 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..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam)Who is involved
.... onBehalfOf Σ0..1Reference(Organization)Organization of the practitioner
.... period 0..1PeriodTime period of participant
... reasonCode 0..*CodeableConceptWhy 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..*ContactPointA contact detail for the care team (that applies to all members)
... note 0..*AnnotationComments made about the CareTeam

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CareTeam.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryrequiredPattern: SNOMED CT code 320741000210108("Secondary prophylaxis team")
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careteam-category-code
from this IG
CareTeam.participant.roleexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
CareTeam.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

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 CareTeam.identifier is sliced based on the value of value:use

Differential View

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... Slices for identifier 0..*IdentifierExternal Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem 0..*IdentifierThis allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 Salesforce object id: CTM-0000144
... category 1..1CodeableConceptType of team
Binding: Rheumatic fever care team category codes (required)
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 320741000210108
..... display1..1stringRepresentation defined by the system
Fixed Value: Secondary prophylaxis team

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet / CodeURI
CareTeam.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CareTeam.categoryrequiredPattern: SNOMED CT code 320741000210108("Secondary prophylaxis team")
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careteam-category-code
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 Salesforce object id: CTM-0000144
... category Σ1..1CodeableConceptType of team
Binding: Rheumatic fever care team category codes (required)

Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 320741000210108
..... display1..1stringRepresentation defined by the system
Fixed Value: Secondary prophylaxis team

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CareTeam.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryrequiredPattern: SNOMED CT code 320741000210108("Secondary prophylaxis team")
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careteam-category-code
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*CareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier Σ0..*IdentifierExternal Ids for this team
Slice: Unordered, Open by value:use
.... identifier:NationalSystem Σ0..*IdentifierThis allows a rheumatic fever patient resource to link with corresponding objects in systems like 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 Salesforce 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)
... status ?!Σ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category Σ1..1CodeableConceptType of team
Binding: Rheumatic fever care team category codes (required)

Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 320741000210108
..... display1..1stringRepresentation defined by the system
Fixed Value: Secondary prophylaxis team
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... name Σ0..1stringName of the team, such as crisis assessment team
... subject Σ0..1Reference(Patient | Group)Who care team is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period team covers
... participant C0..*BackboneElementMembers of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ0..*CodeableConceptType 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..1Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Organization | CareTeam)Who is involved
.... onBehalfOf Σ0..1Reference(Organization)Organization of the practitioner
.... period 0..1PeriodTime period of participant
... reasonCode 0..*CodeableConceptWhy 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..*ContactPointA contact detail for the care team (that applies to all members)
... note 0..*AnnotationComments made about the CareTeam

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CareTeam.identifier:NationalSystem.userequiredPattern: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier:NationalSystem.typerequiredExternalSystemIdentifierTypeValueSet
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/external-system-identifier-type-code
from this IG
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryrequiredPattern: SNOMED CT code 320741000210108("Secondary prophylaxis team")
https://build.fhir.org/ig/tewhatuora/cinc-fhir-ig/ValueSet/rf-careteam-category-code
from this IG
CareTeam.participant.roleexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
CareTeam.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
from the FHIR Standard

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 CareTeam.identifier is sliced based on the value of value:use

 

Other representations of profile: CSV, Excel, Schematron