National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

Resource Profile: National Directory API CareTeam Profile

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-CareTeam Version: 1.0.0-ballot
Active as of 2024-03-28 Computable Name: NdhNdApiCareTeam

Defines the basic constraints and extensions on the CareTeam resource for use in a National Directory of Healthcare Providers & Service (NDH)

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from NdhCareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*NdhCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... meta S0..1MetaMetadata about the resource
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... extension 1..*ExtensionExtension
... extension:careteam-alias S0..*CTAliasAlternate names by which the team is also known
.... value[x] 1..1Reference(National Directory API Location Profile)Value of extension
... extension:healthcareservice S0..*HealthcareServiceReferenceNDH Healthcareservice Reference
.... value[x] 1..1Reference(National Directory API HealthcareService Profile)Value of extension
... extension:endpoint S0..*EndpointReferenceNDH Endpoint Reference
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... extension:verification-status S1..1VerificationStatusNDH Verification Status
... identifier
.... extension:identifier-status S0..1IdentifierStatusNDH Identifier Status
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... assigner S0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... status S1..1codeproposed | active | suspended | inactive | entered-in-error
... period S0..1PeriodTime period team covers
... participant S0..*BackboneElementMembers of the team
.... role S0..*CodeableConceptType of involvement
.... member S0..1Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile)Who is involved
.... period S0..1PeriodTime period of participant
... managingOrganization S0..1Reference(National Directory API Organization Profile)Organization responsible for the care team
... telecom S0..*ContactPointA contact detail for the care team (that applies to all members)
.... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
.... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... note S0..*AnnotationComments made about the CareTeam
.... author[x] S0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorStringstring
.... time S0..1dateTimeWhen the annotation was made
.... text S1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*NdhCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... meta SΣ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... location S0..*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..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(National Directory API Location Profile)Value of extension
... healthcareservice S0..*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..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference"
.... value[x] S1..1Reference(National Directory API HealthcareService Profile)Value of extension
... endpoint S0..*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..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API 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 S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this team
.... identifier-status S0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ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 SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ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: NDH Care Team Category Value Set (extensible)
... name SΣ0..1stringName of the team, such as crisis assessment team
... period SΣ0..1PeriodTime period team covers
... participant SC0..*BackboneElementMembers of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣ0..*CodeableConceptType of involvement
Binding: Individual and Group Specialties (extensible)
.... member SΣ0..1Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile)Who is involved
.... period S0..1PeriodTime period of participant
... managingOrganization SΣ0..1Reference(National Directory API Organization Profile)Organization responsible for the care team
... telecom S0..*ContactPointA contact detail for the care team (that applies to all members)
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... note S0..*AnnotationComments made about the CareTeam
.... author[x] SΣ0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorStringstring
.... time SΣ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryextensibleNDHCareTeamCategoryVS
http://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS
from this IG
CareTeam.participant.roleextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*NdhCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... careteam-alias S0..*stringAlternate names by which the team is also known
URL: http://hl7.org/fhir/StructureDefinition/careteam-alias
... location S0..*Reference(NDH Base Location Profile)NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(National Directory API Location Profile)Value of extension
... healthcareservice S0..*Reference(NDH Base HealthcareService Profile)NDH Healthcareservice Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference"
.... value[x] S1..1Reference(National Directory API HealthcareService Profile)Value of extension
... endpoint S0..*Reference(NDH Base Endpoint Profile)NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API 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 S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... 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 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ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 SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ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: NDH Care Team Category Value Set (extensible)
... name SΣ0..1stringName of the team, such as crisis assessment team
... period SΣ0..1PeriodTime period team covers
... participant SC0..*BackboneElementMembers of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... 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 SΣ0..*CodeableConceptType of involvement
Binding: Individual and Group Specialties (extensible)
.... member SΣ0..1Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile)Who is involved
.... period S0..1PeriodTime period of participant
... managingOrganization SΣ0..1Reference(National Directory API Organization Profile)Organization responsible for the care team
... telecom S0..*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 S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... note S0..*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] SΣ0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorStringstring
.... time SΣ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
CareTeam.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryextensibleNDHCareTeamCategoryVS
http://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS
from this IG
CareTeam.participant.roleextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Differential View

This structure is derived from NdhCareTeam

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*NdhCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... meta S0..1MetaMetadata about the resource
.... profile 1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... extension 1..*ExtensionExtension
... extension:careteam-alias S0..*CTAliasAlternate names by which the team is also known
.... value[x] 1..1Reference(National Directory API Location Profile)Value of extension
... extension:healthcareservice S0..*HealthcareServiceReferenceNDH Healthcareservice Reference
.... value[x] 1..1Reference(National Directory API HealthcareService Profile)Value of extension
... extension:endpoint S0..*EndpointReferenceNDH Endpoint Reference
.... value[x] 1..1Reference(National Directory API Endpoint Profile)Value of extension
... extension:verification-status S1..1VerificationStatusNDH Verification Status
... identifier
.... extension:identifier-status S0..1IdentifierStatusNDH Identifier Status
.... use S0..1codeusual | official | temp | secondary | old (If known)
.... type S0..1CodeableConceptDescription of identifier
.... system S0..1uriThe namespace for the identifier value
.... value S0..1stringThe value that is unique
.... assigner S0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... status S1..1codeproposed | active | suspended | inactive | entered-in-error
... period S0..1PeriodTime period team covers
... participant S0..*BackboneElementMembers of the team
.... role S0..*CodeableConceptType of involvement
.... member S0..1Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile)Who is involved
.... period S0..1PeriodTime period of participant
... managingOrganization S0..1Reference(National Directory API Organization Profile)Organization responsible for the care team
... telecom S0..*ContactPointA contact detail for the care team (that applies to all members)
.... extension:contactpoint-availabletime S0..*ContactPointAvailableTimeNDH Contactpoint Availabletime
.... extension:via-intermediary S0..1ViaIntermediaryNDH Via Intermediary
.... system S0..1codephone | fax | email | pager | url | sms | other
.... value S0..1stringThe actual contact point details
.... use S0..1codehome | work | temp | old | mobile - purpose of this contact point
.... rank S0..1positiveIntSpecify preferred order of use (1 = highest)
... note S0..*AnnotationComments made about the CareTeam
.... author[x] S0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorStringstring
.... time S0..1dateTimeWhen the annotation was made
.... text S1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*NdhCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... meta SΣ0..1MetaMetadata about the resource
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... location S0..*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..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(National Directory API Location Profile)Value of extension
... healthcareservice S0..*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..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference"
.... value[x] S1..1Reference(National Directory API HealthcareService Profile)Value of extension
... endpoint S0..*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..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API 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 S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierExternal Ids for this team
.... identifier-status S0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ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 SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ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: NDH Care Team Category Value Set (extensible)
... name SΣ0..1stringName of the team, such as crisis assessment team
... period SΣ0..1PeriodTime period team covers
... participant SC0..*BackboneElementMembers of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role SΣ0..*CodeableConceptType of involvement
Binding: Individual and Group Specialties (extensible)
.... member SΣ0..1Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile)Who is involved
.... period S0..1PeriodTime period of participant
... managingOrganization SΣ0..1Reference(National Directory API Organization Profile)Organization responsible for the care team
... telecom S0..*ContactPointA contact detail for the care team (that applies to all members)
.... contactpoint-availabletime S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
... note S0..*AnnotationComments made about the CareTeam
.... author[x] SΣ0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorStringstring
.... time SΣ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryextensibleNDHCareTeamCategoryVS
http://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS
from this IG
CareTeam.participant.roleextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..*NdhCareTeamPlanned participants in the coordination and delivery of care for a patient or group
... id Σ0..1idLogical id of this artifact
... meta SΣ0..1MetaMetadata about the resource
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ1..1instantWhen the resource version last changed
.... source Σ0..1uriIdentifies where the resource comes from
.... profile Σ1..1canonical(StructureDefinition)Profiles this resource claims to conform to
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... tag Σ0..*CodingTags 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..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 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... careteam-alias S0..*stringAlternate names by which the team is also known
URL: http://hl7.org/fhir/StructureDefinition/careteam-alias
... location S0..*Reference(NDH Base Location Profile)NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
.... value[x] S1..1Reference(National Directory API Location Profile)Value of extension
... healthcareservice S0..*Reference(NDH Base HealthcareService Profile)NDH Healthcareservice Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference"
.... value[x] S1..1Reference(National Directory API HealthcareService Profile)Value of extension
... endpoint S0..*Reference(NDH Base Endpoint Profile)NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
.... value[x] 1..1Reference(National Directory API 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 S1..1CodeableConceptNDH Verification Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status
Binding: NDH Verification Status Value Set (extensible)
... 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 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... identifier-status S0..1codeNDH Identifier Status
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status
Binding: Identifier Status Value Set (required)
.... use ?!SΣ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type SΣ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 SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ0..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner SΣ0..1Reference(National Directory API Organization Profile)Organization that issued id (may be just text)
... status ?!SΣ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: NDH Care Team Category Value Set (extensible)
... name SΣ0..1stringName of the team, such as crisis assessment team
... period SΣ0..1PeriodTime period team covers
... participant SC0..*BackboneElementMembers of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
.... 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 SΣ0..*CodeableConceptType of involvement
Binding: Individual and Group Specialties (extensible)
.... member SΣ0..1Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile)Who is involved
.... period S0..1PeriodTime period of participant
... managingOrganization SΣ0..1Reference(National Directory API Organization Profile)Organization responsible for the care team
... telecom S0..*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 S0..*(Complex)NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
.... via-intermediary S0..1Reference(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ΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

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

.... rank SΣ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... note S0..*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] SΣ0..1Individual responsible for the annotation
..... authorReferenceReference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorStringstring
.... time SΣ0..1dateTimeWhen the annotation was made
.... text SΣ1..1markdownThe annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CareTeam.meta.securityextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
CareTeam.meta.tagexampleCommonTags
http://hl7.org/fhir/ValueSet/common-tags
from the FHIR Standard
CareTeam.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CareTeam.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
CareTeam.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
CareTeam.statusrequiredCareTeamStatus
http://hl7.org/fhir/ValueSet/care-team-status|4.0.1
from the FHIR Standard
CareTeam.categoryextensibleNDHCareTeamCategoryVS
http://hl7.org/fhir/us/ndh/ValueSet/NDHCareTeamCategoryVS
from this IG
CareTeam.participant.roleextensibleIndividualAndGroupSpecialtiesVS
http://hl7.org/fhir/us/ndh/ValueSet/IndividualAndGroupSpecialtiesVS
from this IG
CareTeam.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
CareTeam.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron