AU Core Implementation Guide
0.2.1-preview - Preview Australia flag

This page is part of the Australian Core IG (v0.2.1-preview: AU Core) based on FHIR R4. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Core CareTeam

Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-careteam Version: 0.2.1-preview
Standards status: Draft Maturity Level: 0 Computable Name: AUCoreCareTeam

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a CareTeam resource to record, search, and fetch information about a care team. It is based on the core CareTeam resource and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the CareTeam when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.

Usage scenarios

The following are supported usage scenarios for this profile:

  • Query for a care team for a patient
  • Record or update a patient’s care team

Comparison with other national and international specifications

A resource conforming to this profile is conformant to:

No equivalent International Patient Access or International Patient Summary profile.

Conformance in reverse is not guaranteed, i.e. a resource conforming to US Core MAY NOT conform to AU Core.

Profile specific implementation guidance

  • Because PractitionerRole supplies a provider’s location, contact information, and reference to the Practitioner, it SHOULD be referenced in CareTeam.member instead of the a Practitioner resource.

Specific feedback is sought on appropriate category values for care teams.

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
... identifier S0..*IdentifierExternal Ids for this team
... status S0..1codeproposed | active | suspended | inactive | entered-in-error
... subject S1..1Reference(AU Core Patient)Who care team is for
.... role S1..*CodeableConceptType of involvement
.... member S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core Organization | AU Core CareTeam)Who is involved

doco Documentation for this format
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
... identifier SΣ0..*IdentifierExternal Ids for this team
... subject SΣ1..1Reference(AU Core Patient)Who care team is for
... participant SC1..*BackboneElementMembers of the team
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣ1..*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 SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core Organization | AU Core CareTeam)Who is involved

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CareTeam.statusrequiredCareTeamStatus
CareTeam.participant.roleexampleParticipantRoles
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
... identifier SΣ0..*IdentifierExternal Ids for this team
... status ?!SΣ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category Σ0..*CodeableConceptType of team
Binding: CareTeamCategory (example): Indicates the type of care team.


... name Σ0..1stringName of the team, such as crisis assessment team
... subject SΣ1..1Reference(AU Core Patient)Who care team is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period team covers
... participant SC1..*BackboneElementMembers of the team
.... 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 SΣ1..*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 SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core Organization | AU Core 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
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
CareTeam.participant.roleexampleParticipantRoles
CareTeam.reasonCodeexampleSNOMEDCTClinicalFindings

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
... identifier S0..*IdentifierExternal Ids for this team
... status S0..1codeproposed | active | suspended | inactive | entered-in-error
... subject S1..1Reference(AU Core Patient)Who care team is for
.... role S1..*CodeableConceptType of involvement
.... member S1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core Organization | AU Core CareTeam)Who is involved

doco Documentation for this format

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
... identifier SΣ0..*IdentifierExternal Ids for this team
... subject SΣ1..1Reference(AU Core Patient)Who care team is for
... participant SC1..*BackboneElementMembers of the team
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣ1..*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 SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core Organization | AU Core CareTeam)Who is involved

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CareTeam.statusrequiredCareTeamStatus
CareTeam.participant.roleexampleParticipantRoles

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
... identifier SΣ0..*IdentifierExternal Ids for this team
... status ?!SΣ0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category Σ0..*CodeableConceptType of team
Binding: CareTeamCategory (example): Indicates the type of care team.


... name Σ0..1stringName of the team, such as crisis assessment team
... subject SΣ1..1Reference(AU Core Patient)Who care team is for
... encounter Σ0..1Reference(Encounter)Encounter created as part of
... period Σ0..1PeriodTime period team covers
... participant SC1..*BackboneElementMembers of the team
.... 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 SΣ1..*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 SΣ1..1Reference(AU Core Practitioner | AU Core PractitionerRole | AU Core RelatedPerson | AU Core Patient | AU Core Organization | AU Core 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
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
CareTeam.participant.roleexampleParticipantRoles
CareTeam.reasonCodeexampleSNOMEDCTClinicalFindings

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Below is an overview of the mandatory and optional search parameters and combined search parameters. FHIR search operations and the syntax used to describe the interactions is described here.

Any search parameter defined in FHIR may be ‘allowed’ by the system unless explicitly marked as “SHALL NOT”. A few items are marked as MAY in this implementation guide to highlight their potential relevance.

Parameter(s) Conformance Type(s) Requirements (when used alone or in combination)
patient SHALL reference The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both.
patient+status SHALL reference+token
patient.identifier SHOULD reference.token The client SHALL provide both the system and code values. The server SHALL support both.

The client SHOULD support search using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile. The server SHOULD support search using the using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
status MAY token The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both.

Mandatory Search Parameters

The following search parameters and search parameter combinations SHALL be supported:

  1. SHALL support searching using the patient search parameter:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])

    GET [base]/CareTeam?patient={Type/}[id] or optionally GET [base]/CareTeam?patient.identifier=[system|][code]

    Example:

    1. GET [base]/CareTeam?patient=5678
    2. GET [base]/CareTeam?patient.identifier=http://ns.electronichealth.net.au/id/medicare-number|32788511952
    3. GET [base]/CareTeam?patient.identifier=http://ns.electronichealth.net.au/id/hi/ihi/1.0|8003608833357361

    Implementation Notes: Fetches a bundle of all CareTeam resources for the specified patient (how to search by reference and how to search by token)

  2. SHALL support searching using the combination of the patient and status search parameters:
    • SHALL support these _revinclude parameters: Provenance:target
    • SHOULD support chained searching of patient canonical identifier patient.identifier (e.g. patient.identifier=[system|][code])
    • SHOULD support multipleOr search on status (e.g.status={system|}[code],{system|}[code],...)

    GET [base]/CareTeam?patient={Type/}[id]&status={system|}[code]{,{system|}[code],...}

    Example:

    1. GET [base]/CareTeam?patient=5678&status=active
    2. GET [base]/CareTeam?patient=5678&status=active&_revinclude=Provenance:target

    Implementation Notes: Fetches a bundle of all CareTeam resources for the specified patient and status (how to search by reference and how to search by token)