National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 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/ndh/StructureDefinition/ndhEx-CareTeam | Version: 1.0.0-ballot | |||
| Active as of 2023-07-30 | Computable Name: NdhExCareTeam | |||
Defines the basic constraints and extensions on the CareTeam resource for use in a National Directory of Healthcare Providers & Service (NDH)
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NdhCareTeam
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CareTeam | 0..* | NdhCareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
  meta | ||||
  profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
  extension | 1..* | Extension | Extension | |
 extension:careteam-alias | S | 0..* | CareteamAlias | Alias |
| extension:location | S | 0..* | LocationReference | NDH Location Reference |
  value[x] | 1..1 | Reference(NDH Exchange Location Profile) | Value of extension | |
| extension:healthcareservice | S | 0..* | HealthcareServiceReference | NDH Healthcareservice Reference |
| value[x] | 1..1 | Reference(NDH Exchange HealthcareService Profile) | Value of extension | |
| extension:endpoint | S | 0..* | EndpointReference | NDH Endpoint Reference |
| value[x] | 1..1 | Reference(NDH Exchange Endpoint Profile) | Value of extension | |
| extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
| identifier | ||||
| extension:identifier-status | S | 0..1 | IdentifierStatus | NDH Identifier Status |
| use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
| type | S | 0..1 | CodeableConcept | Description of identifier |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 0..1 | string | The value that is unique |
| assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
| status | S | 1..1 | code | proposed | active | suspended | inactive | entered-in-error |
| period | S | 0..1 | Period | Time period team covers |
| participant | S | 0..* | BackboneElement | Members of the team |
| role | S | 0..* | CodeableConcept | Type of involvement |
| member | S | 0..1 | Reference(NDH Exchange CareTeam Profile | NDH Exchange PractitionerRole | NDH Exchange Organization Profile) | Who is involved |
| period | S | 0..1 | Period | Time period of participant |
| managingOrganization | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization responsible for the care team |
| telecom | S | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
| extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
| extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 0..1 | string | The actual contact point details |
| use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
| rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
 note | S | 0..* | Annotation | Comments made about the CareTeam |
  author[x] | S | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(NDH Exchange Practitioner Profile | NDH Exchange Organization Profile) | |||
 authorString | string | |||
| time | S | 0..1 | dateTime | When the annotation was made |
| text | S | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam | 0..* | NdhCareTeam | 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 |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careteam-alias | S | 0..* | string | Alias URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-careteam-alias |
| location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference |
 extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |
| value[x] | S | 1..1 | Reference(NDH Exchange Location Profile) | Value of extension |
| healthcareservice | S | 0..* | Reference(NDH Base HealthcareService Profile) | NDH Healthcareservice Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference" | |
| value[x] | S | 1..1 | Reference(NDH Exchange HealthcareService Profile) | Value of extension |
| endpoint | S | 0..* | Reference(NDH Base Endpoint Profile) | NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference" | |
| value[x] | 1..1 | Reference(NDH Exchange Endpoint Profile) | Value of extension | |
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
| verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 0..* | Identifier | External Ids for this team |
| identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 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 | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
| status | ?!SΣ | 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: NDH Care Team Category Value Set (extensible) |
| name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team |
| period | SΣ | 0..1 | Period | Time period team covers |
| participant | SC | 0..* | BackboneElement | Members of the team |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | SΣ | 0..* | CodeableConcept | Type of involvement Binding: Individual and Group Specialties (extensible) |
| member | SΣ | 0..1 | Reference(NDH Exchange CareTeam Profile | NDH Exchange PractitionerRole | NDH Exchange Organization Profile) | Who is involved |
| period | S | 0..1 | Period | Time period of participant |
| managingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization responsible for the care team |
| telecom | S | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
| contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
| via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| note | S | 0..* | Annotation | Comments made about the CareTeam |
| author[x] | SΣ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(NDH Exchange Practitioner Profile | NDH Exchange Organization Profile) | |||
| authorString | string | |||
| time | SΣ | 0..1 | dateTime | When the annotation was made |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CareTeam.identifier.use | required | IdentifierUse |
| CareTeam.identifier.type | extensible | Identifier Type Codes |
| CareTeam.status | required | CareTeamStatus |
| CareTeam.category | extensible | NDHCareTeamCategoryVS |
| CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVS |
| CareTeam.telecom.system | required | ContactPointSystem |
| CareTeam.telecom.use | required | ContactPointUse |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CareTeam | 0..* | NdhCareTeam | 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| careteam-alias | S | 0..* | string | Alias URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-careteam-alias | ||||
| location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |||||
| value[x] | S | 1..1 | Reference(NDH Exchange Location Profile) | Value of extension | ||||
| healthcareservice | S | 0..* | Reference(NDH Base HealthcareService Profile) | NDH Healthcareservice Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference" | |||||
| value[x] | S | 1..1 | Reference(NDH Exchange HealthcareService Profile) | Value of extension | ||||
| endpoint | S | 0..* | Reference(NDH Base Endpoint Profile) | NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference" | |||||
| value[x] | 1..1 | Reference(NDH Exchange Endpoint Profile) | Value of extension | |||||
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
| 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 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 | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 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 | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 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: NDH Care Team Category Value Set (extensible) | ||||
| name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| period | SΣ | 0..1 | Period | Time period team covers | ||||
| participant | SC | 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 | SΣ | 0..* | CodeableConcept | Type of involvement Binding: Individual and Group Specialties (extensible) | ||||
| member | SΣ | 0..1 | Reference(NDH Exchange CareTeam Profile | NDH Exchange PractitionerRole | NDH Exchange Organization Profile) | Who is involved | ||||
| period | S | 0..1 | Period | Time period of participant | ||||
| managingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization responsible for the care team | ||||
| telecom | S | 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 | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
| via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 0..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | SΣ | 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 | S | 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] | SΣ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(NDH Exchange Practitioner Profile | NDH Exchange Organization Profile) | |||||||
| authorString | string | |||||||
| time | SΣ | 0..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CareTeam.meta.security | extensible | All Security Labels | ||||
| CareTeam.meta.tag | example | CommonTags | ||||
| CareTeam.language | preferred | CommonLanguages
| ||||
| CareTeam.identifier.use | required | IdentifierUse | ||||
| CareTeam.identifier.type | extensible | Identifier Type Codes | ||||
| CareTeam.status | required | CareTeamStatus | ||||
| CareTeam.category | extensible | NDHCareTeamCategoryVS | ||||
| CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVS | ||||
| CareTeam.telecom.system | required | ContactPointSystem | ||||
| CareTeam.telecom.use | required | ContactPointUse |
This structure is derived from NdhCareTeam
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NdhCareTeam
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam | 0..* | NdhCareTeam | Planned participants in the coordination and delivery of care for a patient or group | |
| meta | ||||
| profile | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
| extension | 1..* | Extension | Extension | |
| extension:careteam-alias | S | 0..* | CareteamAlias | Alias |
| extension:location | S | 0..* | LocationReference | NDH Location Reference |
| value[x] | 1..1 | Reference(NDH Exchange Location Profile) | Value of extension | |
| extension:healthcareservice | S | 0..* | HealthcareServiceReference | NDH Healthcareservice Reference |
| value[x] | 1..1 | Reference(NDH Exchange HealthcareService Profile) | Value of extension | |
| extension:endpoint | S | 0..* | EndpointReference | NDH Endpoint Reference |
| value[x] | 1..1 | Reference(NDH Exchange Endpoint Profile) | Value of extension | |
| extension:verification-status | S | 1..1 | VerificationStatus | NDH Verification Status |
| identifier | ||||
| extension:identifier-status | S | 0..1 | IdentifierStatus | NDH Identifier Status |
| use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
| type | S | 0..1 | CodeableConcept | Description of identifier |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 0..1 | string | The value that is unique |
| assigner | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
| status | S | 1..1 | code | proposed | active | suspended | inactive | entered-in-error |
| period | S | 0..1 | Period | Time period team covers |
| participant | S | 0..* | BackboneElement | Members of the team |
| role | S | 0..* | CodeableConcept | Type of involvement |
| member | S | 0..1 | Reference(NDH Exchange CareTeam Profile | NDH Exchange PractitionerRole | NDH Exchange Organization Profile) | Who is involved |
| period | S | 0..1 | Period | Time period of participant |
| managingOrganization | S | 0..1 | Reference(NDH Exchange Organization Profile) | Organization responsible for the care team |
| telecom | S | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
| extension:contactpoint-availabletime | S | 0..* | ContactPointAvailableTime | NDH Contactpoint Availabletime |
| extension:via-intermediary | S | 0..1 | ViaIntermediary | NDH Via Intermediary |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | S | 0..1 | string | The actual contact point details |
| use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
| rank | S | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| note | S | 0..* | Annotation | Comments made about the CareTeam |
| author[x] | S | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(NDH Exchange Practitioner Profile | NDH Exchange Organization Profile) | |||
| authorString | string | |||
| time | S | 0..1 | dateTime | When the annotation was made |
| text | S | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CareTeam | 0..* | NdhCareTeam | 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 |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| careteam-alias | S | 0..* | string | Alias URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-careteam-alias |
| location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |
| value[x] | S | 1..1 | Reference(NDH Exchange Location Profile) | Value of extension |
| healthcareservice | S | 0..* | Reference(NDH Base HealthcareService Profile) | NDH Healthcareservice Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference" | |
| value[x] | S | 1..1 | Reference(NDH Exchange HealthcareService Profile) | Value of extension |
| endpoint | S | 0..* | Reference(NDH Base Endpoint Profile) | NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference |
| extension | 0..0 | |||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference" | |
| value[x] | 1..1 | Reference(NDH Exchange Endpoint Profile) | Value of extension | |
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |
| verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 0..* | Identifier | External Ids for this team |
| identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 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 | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 0..1 | string | The value that is unique Example General: 123456 |
| assigner | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) |
| status | ?!SΣ | 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: NDH Care Team Category Value Set (extensible) |
| name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team |
| period | SΣ | 0..1 | Period | Time period team covers |
| participant | SC | 0..* | BackboneElement | Members of the team |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| role | SΣ | 0..* | CodeableConcept | Type of involvement Binding: Individual and Group Specialties (extensible) |
| member | SΣ | 0..1 | Reference(NDH Exchange CareTeam Profile | NDH Exchange PractitionerRole | NDH Exchange Organization Profile) | Who is involved |
| period | S | 0..1 | Period | Time period of participant |
| managingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization responsible for the care team |
| telecom | S | 0..* | ContactPoint | A contact detail for the care team (that applies to all members) |
| contactpoint-availabletime | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime |
| via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| rank | SΣ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| note | S | 0..* | Annotation | Comments made about the CareTeam |
| author[x] | SΣ | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(NDH Exchange Practitioner Profile | NDH Exchange Organization Profile) | |||
| authorString | string | |||
| time | SΣ | 0..1 | dateTime | When the annotation was made |
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CareTeam.identifier.use | required | IdentifierUse |
| CareTeam.identifier.type | extensible | Identifier Type Codes |
| CareTeam.status | required | CareTeamStatus |
| CareTeam.category | extensible | NDHCareTeamCategoryVS |
| CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVS |
| CareTeam.telecom.system | required | ContactPointSystem |
| CareTeam.telecom.use | required | ContactPointUse |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| CareTeam | 0..* | NdhCareTeam | 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 1..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile | Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| careteam-alias | S | 0..* | string | Alias URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-careteam-alias | ||||
| location | S | 0..* | Reference(NDH Base Location Profile) | NDH Location Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference" | |||||
| value[x] | S | 1..1 | Reference(NDH Exchange Location Profile) | Value of extension | ||||
| healthcareservice | S | 0..* | Reference(NDH Base HealthcareService Profile) | NDH Healthcareservice Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference" | |||||
| value[x] | S | 1..1 | Reference(NDH Exchange HealthcareService Profile) | Value of extension | ||||
| endpoint | S | 0..* | Reference(NDH Base Endpoint Profile) | NDH Endpoint Reference URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference" | |||||
| value[x] | 1..1 | Reference(NDH Exchange Endpoint Profile) | Value of extension | |||||
| usage-restriction | 0..* | Reference(NDH Base Restriction) {c} | Usage Restriction URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction | |||||
| verification-status | S | 1..1 | CodeableConcept | NDH Verification Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status Binding: NDH Verification Status Value Set (extensible) | ||||
| 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 | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| identifier-status | S | 0..1 | code | NDH Identifier Status URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status Binding: Identifier Status Value Set (required) | ||||
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 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 | SΣ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 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 | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization that issued id (may be just text) | ||||
| status | ?!SΣ | 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: NDH Care Team Category Value Set (extensible) | ||||
| name | SΣ | 0..1 | string | Name of the team, such as crisis assessment team | ||||
| period | SΣ | 0..1 | Period | Time period team covers | ||||
| participant | SC | 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 | SΣ | 0..* | CodeableConcept | Type of involvement Binding: Individual and Group Specialties (extensible) | ||||
| member | SΣ | 0..1 | Reference(NDH Exchange CareTeam Profile | NDH Exchange PractitionerRole | NDH Exchange Organization Profile) | Who is involved | ||||
| period | S | 0..1 | Period | Time period of participant | ||||
| managingOrganization | SΣ | 0..1 | Reference(NDH Exchange Organization Profile) | Organization responsible for the care team | ||||
| telecom | S | 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 | S | 0..* | (Complex) | NDH Contactpoint Availabletime URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime | ||||
| via-intermediary | S | 0..1 | Reference(NDH Base PractitionerRole | NDH Base OrganizationAffiliation Profile | NDH Base Location Profile | NDH Base Organization Profile) | NDH Via Intermediary URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary | ||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 0..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | SΣ | 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 | S | 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] | SΣ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(NDH Exchange Practitioner Profile | NDH Exchange Organization Profile) | |||||||
| authorString | string | |||||||
| time | SΣ | 0..1 | dateTime | When the annotation was made | ||||
| text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CareTeam.meta.security | extensible | All Security Labels | ||||
| CareTeam.meta.tag | example | CommonTags | ||||
| CareTeam.language | preferred | CommonLanguages
| ||||
| CareTeam.identifier.use | required | IdentifierUse | ||||
| CareTeam.identifier.type | extensible | Identifier Type Codes | ||||
| CareTeam.status | required | CareTeamStatus | ||||
| CareTeam.category | extensible | NDHCareTeamCategoryVS | ||||
| CareTeam.participant.role | extensible | IndividualAndGroupSpecialtiesVS | ||||
| CareTeam.telecom.system | required | ContactPointSystem | ||||
| CareTeam.telecom.use | required | ContactPointUse |
This structure is derived from NdhCareTeam
Summary
Mandatory: 2 elements (1 nested mandatory element)
Must-Support: 29 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International - Patient Administration Work Group. Package hl7.fhir.us.ndh#1.0.0-ballot based on FHIR 4.0.1. Generated 2023-07-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change