Clinical
Summary
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R4B
R4
R3
|
Responsible
Owner:
Patient
Care
|
Standards Status : Informative | Compartments : Group , Patient , Practitioner , RelatedPerson |
Raw
XML
(
canonical
form
+
also
see
XML
Format
Specification
)
Definition
for
Value
SetEntityNamePartQualifier
<?xml version="1.0" encoding="UTF-8"?>
A set of codes each of which specifies a certain subcategory of the name part in addition
to the main name part type.
Include these codes as defined in
For organizations a suffix indicating the legal status, e.g., Inc., "Co.", "AG",
"GmbH", "B.V." "S.A.", "Ltd." Etc.
Indicates that a prefix like "Dr." or a suffix like "M.D." or "Ph.D."
is an academic title.
In Europe and Asia, there are still people with nobility titles (aristocrats). German
"von" is generally a nobility title, not a mere voorvoegsel. Others are "Earl
of" or "His Majesty King of..." etc. Rarely used nowadays, but some systems
do keep track of this.
Primarily in the British Imperial culture people tend to have an abbreviation of their
professional organization as part of their credential suffices
A name that a person was given at birth or established as a consequence of adoption. NOTE:
This is not used for temporary names assigned at birth such as 'Baby of Smith' – which
is just a name with a use code of TEMP
A name part a person acquired. The name part may be acquired by adoption, or the person
may have chosen to use the name part for some other reason. NOTE This differs from an
other/psuedonym/alias in that an acquired name part is acquired on a formal basis rather
than an informal one (e.g. registered as part of the official name)
The name assumed from the partner in a marital relationship. Usually the spouse‘s family
name. No inference about gender may be made from the existence of spouse names
Indicates that the name part is a middle name. In general, the English "middle
name" concept is all of the given names after the first. This qualifier may be used
to explicitly indicate which given names are considered to be middle names. The middle
name qualifier may also be used with family names. This is a Scandinavian use case, matching
the concept of "mellomnavn"/"mellannamn". There are specific rules
that indicate what names may be taken as a mellannamnin different Scandinavian countries
Callme is used to indicate which of the various name parts is used when interacting with
the person
Indicates that a name part is just an initial. Initials do not imply a trailing period
since this would not work with non-Latin scripts. Initials may consist of more than one
letter, e.g., "Ph." could stand for "Philippe" or "Th."
for "Thomas"
Include these codes as defined in
A Dutch "voorvoegsel" is something like "van" or "de" that
might have indicated nobility in the past but no longer so. Similar prefixes exist in
other languages such as German, Spanish, French or Portugese
A set of codes each of which specifies a certain subcategory of the name part in addition
to the main name part type.
For organizations a suffix indicating the legal status, e.g., Inc., "Co.", "AG",
"GmbH", "B.V." "S.A.", "Ltd." Etc.
Indicates that a prefix like "Dr." or a suffix like "M.D." or "Ph.D."
is an academic title.
In Europe and Asia, there are still people with nobility titles (aristocrats). German
"von" is generally a nobility title, not a mere voorvoegsel. Others are "Earl
of" or "His Majesty King of..." etc. Rarely used nowadays, but some systems
do keep track of this.
Primarily in the British Imperial culture people tend to have an abbreviation of their
professional organization as part of their credential suffices
A name that a person was given at birth or established as a consequence of adoption. NOTE:
This is not used for temporary names assigned at birth such as 'Baby of Smith' – which
is just a name with a use code of TEMP
A name part a person acquired. The name part may be acquired by adoption, or the person
may have chosen to use the name part for some other reason. NOTE This differs from an
other/psuedonym/alias in that an acquired name part is acquired on a formal basis rather
than an informal one (e.g. registered as part of the official name)
The name assumed from the partner in a marital relationship. Usually the spouse‘s family
name. No inference about gender may be made from the existence of spouse names
Indicates that the name part is a middle name. In general, the English "middle
name" concept is all of the given names after the first. This qualifier may be used
to explicitly indicate which given names are considered to be middle names. The middle
name qualifier may also be used with family names. This is a Scandinavian use case, matching
the concept of "mellomnavn"/"mellannamn". There are specific rules
that indicate what names may be taken as a mellannamnin different Scandinavian countries
Callme is used to indicate which of the various name parts is used when interacting with
the person
Indicates that a name part is just an initial. Initials do not imply a trailing period
since this would not work with non-Latin scripts. Initials may consist of more than one
letter, e.g., "Ph." could stand for "Philippe" or "Th."
for "Thomas"
A Dutch "voorvoegsel" is something like "van" or "de" that
might have indicated nobility in the past but no longer so. Similar prefixes exist in
other languages such as German, Spanish, French or Portugese
</
ValueSet
>
Usage
note:
every
effort
has
been
made
to
ensure
that
This
is
a
representation
of
the
examples
are
correct
and
useful,
but
they
are
not
json
schema
for
CareTeam,
which
is
just
a
normative
part
of
the
specification.
full
JSON
Schema
.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/CareTeam",
"$ref": "#/definitions/CareTeam",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"CareTeam": {
"description": "The Care Team includes all the people, organizations, and care teams who participate or plan to participate in the coordination and delivery of care.",
"properties": {
"resourceType": {
"description": "This is a CareTeam resource",
"const": "CareTeam"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Business identifiers assigned to this care team by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "Indicates the current state of the care team.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"category": {
"description": "Identifies what kind of team. This is to support differentiation between multiple co-existing teams, such as care plan team, episode of care team, longitudinal care team.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"name": {
"description": "A label for human use intended to distinguish like teams. E.g. the \"red\" vs. \"green\" trauma teams.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"subject": {
"description": "Identifies the patient or group whose intended care is handled by the team.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"period": {
"description": "Indicates when the team did (or is intended to) come into effect and end.",
"$ref": "Period.schema.json#/definitions/Period"
},
"participant": {
"description": "Identifies all people and organizations who are expected to be involved in the care team.",
"items": {
"$ref": "#/definitions/CareTeam_Participant"
},
"type": "array"
},
"reason": {
"description": "Describes why the care team exists.",
"items": {
"$ref": "CodeableReference.schema.json#/definitions/CodeableReference"
},
"type": "array"
},
"managingOrganization": {
"description": "The organization responsible for the care team.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"telecom": {
"description": "A central contact detail for the care team (that applies to all members).",
"items": {
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"type": "array"
},
"note": {
"description": "Comments made about the CareTeam.",
"items": {
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false,
"required": [
"resourceType"
]
},
"CareTeam_Participant": {
"description": "The Care Team includes all the people, organizations, and care teams who participate or plan to participate in the coordination and delivery of care.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"role": {
"description": "Indicates specific responsibility of an individual within the care team, such as \"Primary care physician\", \"Trained social worker counselor\", \"Caregiver\", etc.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"member": {
"description": "The specific person or organization who is participating/expected to participate in the care team.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"onBehalfOf": {
"description": "Entity that the participant is acting as a proxy of, or an agent of, or in the interest of, or as a representative of.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"effectivePeriod": {
"description": "When the member is generally available within this care team.",
"$ref": "Period.schema.json#/definitions/Period"
},
"effectiveTiming": {
"description": "When the member is generally available within this care team.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"supportingInfo": {
"description": "The basis for the member\u0027s role participation in care team. For example, supporting documentation that establishes legal power of attorney or court ordered guardianship.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"type": "object",
"additionalProperties": false
}
}
}
®©
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Wed,
Nov
1,
2019
09:32+1100.
QA
Page
12,
2025
19:44+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change