National Healthcare Directory Query
1.0.0-ballot - ballot
US
National Healthcare Directory Query
1.0.0-ballot - ballot
US
This page is part of the National Healthcare Query (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDirEndpointQry-CareTeam | Version: 1.0.0-ballot | |||
| Active as of 2022-08-09 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CareTeam
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
This structure is derived from CareTeam
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |||||
  id | Σ | 0..1 | string | 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
 alias | 0..* | string | Alternate 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 | S | 0..* | 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..* | Extension | Extensions that cannot be ignored | ||||
 identifier | SΣ | 0..* | Identifier | External Ids for this team | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status | 1..1 | code | Status URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status Binding: Identifier Status Value Set (required) | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
  assigner | Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
| category | SΣ | 1..* | CodeableConcept | Type of team Binding: CareTeamCategory (example): Indicates the type of care team. | ||||
| name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| period | Σ | 0..1 | Period | Time period team covers | ||||
| participant | I | 0..* | BackboneElement | Members of the team | ||||
| 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(National Directory Endpoint Qry Care Team | National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange Organization) | Who is involved | ||||
| period | 0..1 | Period | Time period of participant | |||||
| managingOrganization | Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization responsible for the care team | ||||
| telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional 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 | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
 note | 0..* | Annotation | Comments made about the CareTeam | |||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(National Directory Endpoint Qry Exchange Practitioner) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
| endpoint | 0..* | Reference(National Directory Endpoint Qry Exchange Endpoint) | Endpoints for the care team URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/endpoint-reference | |
| identifier | Σ | 0..* | Identifier | External Ids for this team |
| category | Σ | 1..* | 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 |
| Documentation for this format | ||||
This structure is derived from CareTeam
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Must-Support: 4 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from CareTeam
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CareTeam | 0..* | CareTeam | Planned participants in the coordination and delivery of care for a patient or group | |||||
| id | Σ | 0..1 | string | 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 | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| alias | 0..* | string | Alternate 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 | S | 0..* | 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..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | External Ids for this team | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| status | 1..1 | code | Status URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/identifier-status Binding: Identifier Status Value Set (required) | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | proposed | active | suspended | inactive | entered-in-error Binding: CareTeamStatus (required): Indicates the status of the care team. | ||||
| category | SΣ | 1..* | CodeableConcept | Type of team Binding: CareTeamCategory (example): Indicates the type of care team. | ||||
| name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| period | Σ | 0..1 | Period | Time period team covers | ||||
| participant | I | 0..* | BackboneElement | Members of the team | ||||
| 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(National Directory Endpoint Qry Care Team | National Directory Endpoint Qry Exchange PractitionerRole | National Directory Endpoint Qry Exchange Organization) | Who is involved | ||||
| period | 0..1 | Period | Time period of participant | |||||
| managingOrganization | Σ | 0..1 | Reference(National Directory Endpoint Qry Exchange Organization) | Organization responsible for the care team | ||||
| telecom | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional 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 | ΣI | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | Σ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| note | 0..* | Annotation | Comments made about the CareTeam | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(National Directory Endpoint Qry Exchange Practitioner) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| CareTeam.language | preferred | CommonLanguages Max Binding: AllLanguages |
| CareTeam.identifier.use | required | IdentifierUse |
| CareTeam.identifier.type | extensible | Identifier Type Codes |
| CareTeam.status | required | CareTeamStatus |
| CareTeam.category | example | CareTeamCategory |
| CareTeam.participant.role | example | ParticipantRoles |
| CareTeam.telecom.system | required | ContactPointSystem |
| CareTeam.telecom.use | required | ContactPointUse |
IG © 2021+ HL7 International - Patient Administration Work Group. Package hl7.fhir.us.directory-query#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-08-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
