STU 2 Ballot

This page is part of the Data Access Framework (v1.6.0: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: DAF-core-careteam

This profile sets minimum expectations for the CareTeam resource for identifying the Care team members associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Example Usage Scenarios:

The following are example usage scenarios for the DAF-CareTeam profile:

  • Query for a Patient’s CareTeam
  • Query for all Patient’ with a particular careteam member
Mandatory Data Elements and Terminology

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and an example are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each CareTeam must have:

  1. a status code
  2. a patient
  3. a participant role for each careteam members
  4. names of careteam members which can be:
    • a practitioner (doctor, nurse, therapist)
    • the patient
    • a relative or friend or guardian
    • an organization

Profile specific implementation guidance:

  • none
Example: CareTeam Example: example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/us/daf/StructureDefinition/daf-core-careteam

This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by Health Level Seven International (FHIR-Infrastructure).

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

This structure is derived from CareTeam

Complete Summary of the Mandatory Requirements

  1. One status in CareTeam.status
  2. One reference to a patient in CareTeam.subject
  3. One participant role for each careteam member in CareTeam.participant.role
  4. Careteam members in CareTeam.participant.member
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam I0..*Planned participants in the coordination and delivery of care for a patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ∑0..*IdentifierExternal Ids for this team
... status ?!S1..1CodeableConceptactive | suspended | inactive | entered in error
Binding: CareTeamStatus (required)
... type ∑0..*CodeableConceptType of team
... name ∑0..1stringName of the team, such as crisis assessment team
... subject S1..1Reference(Profile daf-core-patient)Who care team is for
... period ∑0..1PeriodTime period team covers
... participant S1..*BackboneElementMembers of the team
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role S1..1CodeableConceptType of involvement
Binding: CareTeam Provider Roles (required)
.... member S1..1Reference(Practitioner | RelatedPerson | Patient | Organization)Who is involved
.... period 0..1PeriodTime period of participant
... managingOrganization ∑0..1Reference(Organization)Organization responsible for the care team

doco Documentation for this format

yet to be done: Xml template

yet to be done: Json template

This structure is derived from CareTeam

Summary

Mandatory: 5 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam I0..*Planned participants in the coordination and delivery of care for a patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
... 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
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..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 ∑0..*IdentifierExternal Ids for this team
... status ?!S1..1CodeableConceptactive | suspended | inactive | entered in error
Binding: CareTeamStatus (required)
... type ∑0..*CodeableConceptType of team
... name ∑0..1stringName of the team, such as crisis assessment team
... subject S1..1Reference(Profile daf-core-patient)Who care team is for
... period ∑0..1PeriodTime period team covers
... participant S1..*BackboneElementMembers of the team
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... role S1..1CodeableConceptType of involvement
Binding: CareTeam Provider Roles (required)
.... member S1..1Reference(Practitioner | RelatedPerson | Patient | Organization)Who is involved
.... period 0..1PeriodTime period of participant
... managingOrganization ∑0..1Reference(Organization)Organization responsible for the care team

doco Documentation for this format

XML Template

yet to be done: Xml template

JSON Template

yet to be done: Json template

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
CareTeam.languageCommon LanguagesextensibleCommon Languages
CareTeam.statusCareTeamStatusrequiredCareTeamStatus
CareTeam.participant.roleCareTeam Provider RolesrequiredCareTeam Provider Roles

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CareTeamIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1CareTeamIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4CareTeamIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3CareTeamIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
.