National Healthcare Directory Query
1.0.0-ballot - ballot United States of America flag

National Healthcare Directory Query, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-query/ and changes regularly. See the Directory of published versions

Resource Profile: National Directory Endpoint Qry Care Team

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-CareTeam Version: 1.0.0-ballot
Active as of 2022-12-08 Computable Name: NatlDirEndpointQryCareTeam

Copyright/Legal: HL7 International

Defines the basic constraints and extensions on the CareTeam resource for use in a Validated Healthcare Directory

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 extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... alias 0..*stringAlternate name for care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/careteam-alias
... location 0..*Reference(National Directory Endpoint Qry Exchange Location)Where the care team operates
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Endpoints for the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference
... restriction 0..*Reference(National Directory Endpoint Qry Exchange Restriction)Restriction
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction
... identifier S0..*IdentifierExternal Ids for this team
.... extension 1..*ExtensionExtension
.... status 1..1codeStatus
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that issued id (may be just text)
... status 1..1codeproposed | active | suspended | inactive | entered-in-error
... category S1..*CodeableConceptType of team
... name S0..1stringName of the team, such as crisis assessment team
... subject 0..0
... encounter 0..0
... participant
.... member 0..1Reference(National Directory Endpoint Qry Care Team | National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange Organization)Who is involved
.... onBehalfOf 0..0
... reasonCode 0..0
... reasonReference 0..0
... managingOrganization 0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for the care team
... telecom
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory Endpoint Qry Exchange Practitioner)
..... authorStringstring

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... alias 0..*stringAlternate name for care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/careteam-alias
... service 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)Services provided by the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/healthcareservice-reference
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Endpoints for the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference
... restriction 0..*Reference(National Directory Endpoint Qry Exchange Restriction)Restriction
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this team
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status 1..1codeStatus
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

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


... name SΣ0..1stringName of the team, such as crisis assessment team
... managingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for the care team

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CareTeam.identifier.userequiredIdentifierUse
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... alias 0..*stringAlternate name for care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/careteam-alias
... location 0..*Reference(National Directory Endpoint Qry Exchange Location)Where the care team operates
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
... service 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)Services provided by the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/healthcareservice-reference
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Endpoints for the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference
... restriction 0..*Reference(National Directory Endpoint Qry Exchange Restriction)Restriction
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this team
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status 1..1codeStatus
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

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


... name SΣ0..1stringName of the team, such as crisis assessment team
... period Σ0..1PeriodTime period team covers
... participant C0..*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 Σ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(National Directory Endpoint Qry Care Team | National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange Organization)Who is involved
.... period 0..1PeriodTime period of participant
... managingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for the care team
... telecom 0..*ContactPointA contact detail for the care team (that applies to all members)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... note 0..*AnnotationComments made about the CareTeam
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory Endpoint Qry Exchange Practitioner)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CareTeam.identifier.userequiredIdentifierUse
CareTeam.identifier.typeextensibleIdentifier Type Codes
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
CareTeam.participant.roleexampleParticipantRoles
CareTeam.telecom.systemrequiredContactPointSystem
CareTeam.telecom.userequiredContactPointUse

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 extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... alias 0..*stringAlternate name for care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/careteam-alias
... location 0..*Reference(National Directory Endpoint Qry Exchange Location)Where the care team operates
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Endpoints for the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference
... restriction 0..*Reference(National Directory Endpoint Qry Exchange Restriction)Restriction
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction
... identifier S0..*IdentifierExternal Ids for this team
.... extension 1..*ExtensionExtension
.... status 1..1codeStatus
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status
Binding: Identifier Status Value Set (required)
.... assigner 0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that issued id (may be just text)
... status 1..1codeproposed | active | suspended | inactive | entered-in-error
... category S1..*CodeableConceptType of team
... name S0..1stringName of the team, such as crisis assessment team
... subject 0..0
... encounter 0..0
... participant
.... member 0..1Reference(National Directory Endpoint Qry Care Team | National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange Organization)Who is involved
.... onBehalfOf 0..0
... reasonCode 0..0
... reasonReference 0..0
... managingOrganization 0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for the care team
... telecom
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
... note
.... author[x] 0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory Endpoint Qry Exchange Practitioner)
..... authorStringstring

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... alias 0..*stringAlternate name for care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/careteam-alias
... service 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)Services provided by the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/healthcareservice-reference
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Endpoints for the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference
... restriction 0..*Reference(National Directory Endpoint Qry Exchange Restriction)Restriction
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this team
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status 1..1codeStatus
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... assigner Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

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


... name SΣ0..1stringName of the team, such as crisis assessment team
... managingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for the care team

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CareTeam.identifier.userequiredIdentifierUse
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory

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
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... alias 0..*stringAlternate name for care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/careteam-alias
... location 0..*Reference(National Directory Endpoint Qry Exchange Location)Where the care team operates
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/location-reference
... service 0..*Reference(National Directory Endpoint Qry Exchange HealthcareService)Services provided by the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/healthcareservice-reference
... endpoint S0..*Reference(National Directory Endpoint Qry Exchange Endpoint)Endpoints for the care team
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference
... restriction 0..*Reference(National Directory Endpoint Qry Exchange Restriction)Restriction
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this team
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... status 1..1codeStatus
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization that issued id (may be just text)
... status ?!Σ1..1codeproposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.

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


... name SΣ0..1stringName of the team, such as crisis assessment team
... period Σ0..1PeriodTime period team covers
... participant C0..*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 Σ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(National Directory Endpoint Qry Care Team | National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange Organization)Who is involved
.... period 0..1PeriodTime period of participant
... managingOrganization Σ0..1Reference(National Directory Endpoint Qry Exchange Organization)Organization responsible for the care team
... telecom 0..*ContactPointA contact detail for the care team (that applies to all members)
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... contactpoint-availabletime 0..*(Complex)Contactpoint Availabletime
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/contactpoint-availabletime
.... via-intermediary 0..*Reference(National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange OrganizationAffiliation | National Directory Endpoint Qry Exchange Location | National Directory Endpoint Qry Exchange Organization)Via Intermediary
URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/via-intermediary
.... system ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... note 0..*AnnotationComments made about the CareTeam
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory Endpoint Qry Exchange Practitioner)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
CareTeam.identifier.userequiredIdentifierUse
CareTeam.identifier.typeextensibleIdentifier Type Codes
CareTeam.statusrequiredCareTeamStatus
CareTeam.categoryexampleCareTeamCategory
CareTeam.participant.roleexampleParticipantRoles
CareTeam.telecom.systemrequiredContactPointSystem
CareTeam.telecom.userequiredContactPointUse

 

Other representations of profile: CSV, Excel, Schematron