National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0 - STU1 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 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
Standards status: Trial-use 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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. CareTeam 0..* NdhCareTeam Planned participants in the coordination and delivery of care for a patient or group
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta SΣ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
.... lastUpdated Σ 1..1 instant When the resource version last changed
ele-1: All FHIR elements must have a @value or children
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
ele-1: All FHIR elements must have a @value or children
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:careteam-alias S 0..* string Alternate names by which the team is also known
URL: http://hl7.org/fhir/StructureDefinition/careteam-alias
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension:location S 0..* (Complex) NDH Location Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"
..... value[x] S 1..1 Reference(National Directory API Location Profile) Value of extension
ele-1: All FHIR elements must have a @value or children
.... extension:healthcareservice S 0..* (Complex) NDH Healthcareservice Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-healthcareservice-reference"
..... value[x] S 1..1 Reference(National Directory API HealthcareService Profile) Value of extension
ele-1: All FHIR elements must have a @value or children
.... extension:endpoint S 0..* (Complex) NDH Endpoint Reference
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-reference"
..... value[x] 1..1 Reference(National Directory API Endpoint Profile) Value of extension
ele-1: All FHIR elements must have a @value or children
.... extension:usage-restriction 0..* Reference(NDH Base Restriction) {c} Usage Restriction
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-usage-restriction
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier SΣ 0..* Identifier External Ids for this team
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension: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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... use ?!SΣ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... 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.


ele-1: All FHIR elements must have a @value or children
.... system SΣ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... assigner SΣ 0..1 Reference(National Directory API Organization Profile) Organization that issued id (may be just text)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code proposed | active | suspended | inactive | entered-in-error
Binding: CareTeamStatus (required): Indicates the status of the care team.


ele-1: All FHIR elements must have a @value or children
... category SΣ 1..* CodeableConcept Type of team
Binding: NDH Care Team Category Value Set (extensible)
ele-1: All FHIR elements must have a @value or children
... name SΣ 0..1 string Name of the team, such as crisis assessment team
ele-1: All FHIR elements must have a @value or children
... period SΣ 0..1 Period Time period team covers
ele-1: All FHIR elements must have a @value or children
... participant SC 0..* BackboneElement Members of the team
ctm-1: CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... role SΣ 0..* CodeableConcept Type of involvement
Binding: Individual and Group Specialties (extensible)
ele-1: All FHIR elements must have a @value or children
.... member SΣ 0..1 Reference(National Directory API CareTeam Profile | National Directory API PractitionerRole | National Directory API Organization Profile) Who is involved
ele-1: All FHIR elements must have a @value or children
.... period S 0..1 Period Time period of participant
ele-1: All FHIR elements must have a @value or children
... managingOrganization SΣ 0..1 Reference(National Directory API Organization Profile) Organization responsible for the care team
ele-1: All FHIR elements must have a @value or children
... telecom S 0..* ContactPoint A contact detail for the care team (that applies to all members)
ele-1: All FHIR elements must have a @value or children
.... Slices for extension Content/Rules for all slices
..... extension:contactpoint-availabletime S 0..* (Complex) NDH Contactpoint Availabletime
URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... extension: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
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... system SΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value SΣ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!SΣ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children
.... rank SΣ 0..1 positiveInt Specify preferred order of use (1 = highest)
ele-1: All FHIR elements must have a @value or children
... note S 0..* Annotation Comments made about the CareTeam
ele-1: All FHIR elements must have a @value or children
.... author[x] SΣ 0..1 Individual responsible for the annotation
ele-1: All FHIR elements must have a @value or children
..... authorReference Reference(National Directory API Practitioner Profile | National Directory API Organization Profile)
..... authorString string
.... time SΣ 0..1 dateTime When the annotation was made
ele-1: All FHIR elements must have a @value or children
.... text SΣ 1..1 markdown The annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children

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

 

Other representations of profile: CSV, Excel, Schematron