QI-Core Implementation Guide: STU 4 (v4.0.0 for FHIR 4.0.1)

QI-Core Implementation Guide - This is the current published version.. See the Directory of published versions

D.4.1 StructureDefinition-qicore-careteam

Introduction:

See the patterns page for implementation and usage patterns.

Examples:

Antenatal Care Team Example

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is:

http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-careteam

Profile of CareTeam for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile builds on USCoreCareTeam.

This profile was published on Wed Aug 22 00:00:00 UTC 2018 as a draft by Health Level Seven, Inc. - CQI WG.

Description of Profiles, Differentials, and Snapshots.

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam I0..*USCoreCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Ids for this team
... status ?!SΣI0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required)
... category ΣI0..*CodeableConceptType of team
Binding: CareTeamCategory (example)
... name ΣI0..1stringName of the team, such as crisis assessment team
... subject SΣI1..1Reference(QICorePatient)Who care team is for
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... period ΣI0..1PeriodTime period team covers
... participant SI1..*BackboneElementMembers of the team
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣI1..1CodeableConceptType of involvement
Binding: US Core CareTeam Provider Roles (extensible)
Max Binding: US Core CareTeam Provider Roles
.... member SΣI1..1Reference(QICorePatient | QICorePractitioner | QICoreOrganization | RelatedPerson)Who is involved
.... onBehalfOf ΣI0..1Reference(Organization)Organization of the practitioner
.... period I0..1PeriodTime period of participant
... reasonCode I0..*CodeableConceptWhy the care team exists
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference I0..*Reference(Condition)Why the care team exists
... managingOrganization ΣI0..*Reference(Organization)Organization responsible for the care team
... telecom I0..*ContactPointA contact detail for the care team (that applies to all members)
... note I0..*AnnotationComments made about the CareTeam

doco Documentation for this format

Summary

Mandatory: 4 elements
Must-Support: 4 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam I0..*USCoreCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Ids for this team
... status ?!SΣI0..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required)
... category ΣI0..*CodeableConceptType of team
Binding: CareTeamCategory (example)
... name ΣI0..1stringName of the team, such as crisis assessment team
... subject SΣI1..1Reference(QICorePatient)Who care team is for
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... period ΣI0..1PeriodTime period team covers
... participant SI1..*BackboneElementMembers of the team
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣI1..1CodeableConceptType of involvement
Binding: US Core CareTeam Provider Roles (extensible)
Max Binding: US Core CareTeam Provider Roles
.... member SΣI1..1Reference(QICorePatient | QICorePractitioner | QICoreOrganization | RelatedPerson)Who is involved
.... onBehalfOf ΣI0..1Reference(Organization)Organization of the practitioner
.... period I0..1PeriodTime period of participant
... reasonCode I0..*CodeableConceptWhy the care team exists
Binding: SNOMEDCTClinicalFindings (example)
... reasonReference I0..*Reference(Condition)Why the care team exists
... managingOrganization ΣI0..*Reference(Organization)Organization responsible for the care team
... telecom I0..*ContactPointA contact detail for the care team (that applies to all members)
... note I0..*AnnotationComments made about the CareTeam

doco Documentation for this format

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
CareTeam.languagepreferredCommonLanguages
Max Binding: AllLanguages
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
CareTeam.participant.roleextensibleUSCoreCareTeamProviderRoles
Max Binding: US Core CareTeam Provider Roles
CareTeam.reasonCodeexampleSNOMEDCTClinicalFindings

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2CareTeamIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3CareTeamIf 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-4CareTeamIf 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-5CareTeamIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6CareTeamA resource should have narrative for robust management
: text.`div`.exists()
ele-1CareTeam.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CareTeam.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CareTeam.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CareTeam.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CareTeam.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ctm-1CareTeam.participantCareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
: onBehalfOf.exists() implies (member.resolve().iif(empty(), true, ofType(Practitioner).exists()))
ele-1CareTeam.participantAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.participant.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CareTeam.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CareTeam.participant.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1CareTeam.participant.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1CareTeam.participant.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.participant.memberAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.participant.onBehalfOfAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.participant.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.reasonCodeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.reasonReferenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.managingOrganizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1CareTeam.noteAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())