HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1
1.0.0 - STU1 International flag

HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. 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/hl7-pt/resp-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Inspirers Base CareTeam Profile

Official URL: http://example.com/fhir/example/StructureDefinition/inspirers-careteam Version: 1.0.0
Active as of 2024-09-24 Computable Name: InspirersCareTeam

Defines constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve patient CareTeam.

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

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..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... subject S 1..1 Reference(Patient | Group) Who care team is for

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCareTeamIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCareTeamIf 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-4errorCareTeamIf 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-5errorCareTeamIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCareTeamA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this team
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category Σ 0..* 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 SΣ 1..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
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... 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

PathConformanceValueSetURI
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryexampleCareTeamCategory
http://hl7.org/fhir/ValueSet/care-team-category
from the FHIR Standard
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

Constraints

IdGradePath(s)DetailsRequirements
ctm-1errorCareTeam.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()))
dom-2errorCareTeamIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCareTeamIf 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-4errorCareTeamIf 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-5errorCareTeamIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCareTeamA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CareTeam

Summary

Mandatory: 1 element
Must-Support: 1 element

Differential View

This structure is derived from CareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... subject S 1..1 Reference(Patient | Group) Who care team is for

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCareTeamIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCareTeamIf 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-4errorCareTeamIf 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-5errorCareTeamIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCareTeamA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* CareTeam Planned participants in the coordination and delivery of care for a patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this team
... status ?!Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

... category Σ 0..* 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 SΣ 1..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
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... 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

PathConformanceValueSetURI
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryexampleCareTeamCategory
http://hl7.org/fhir/ValueSet/care-team-category
from the FHIR Standard
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

Constraints

IdGradePath(s)DetailsRequirements
ctm-1errorCareTeam.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()))
dom-2errorCareTeamIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCareTeamIf 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-4errorCareTeamIf 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-5errorCareTeamIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCareTeamA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CareTeam

Summary

Mandatory: 1 element
Must-Support: 1 element

 

Other representations of profile: CSV, Excel, Schematron