US Core Implementation Guide
STU 2
This page is part of the US Core (v2.0.0: STU2) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
Formats: Narrative, XML, JSON, Turtle
Download Raw json
{
"resourceType" : "StructureDefinition",
"id" : "us-core-careteam",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-careteam-definitions.html#CareTeam" title="The US Core CareTeam Profile is based upon the core FHIR CareTeam Resource and created to meet the 2015 Edition Common Clinical Data Set 'Care team member(s)' requirements.">CareTeam</a><a name="CareTeam"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">US Core CareTeam Profile</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-us-core-careteam-definitions.html#CareTeam.status">status</a><a name="CareTeam.status"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/STU3/valueset-care-team-status.html">CareTeamStatus</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set.">required</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-us-core-careteam-definitions.html#CareTeam.subject">subject</a><a name="CareTeam.subject"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-us-core-patient.html">US Core Patient Profile</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck01.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-careteam-definitions.html#CareTeam.participant">participant</a><a name="CareTeam.participant"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..*</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#BackboneElement">BackboneElement</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck010.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-us-core-careteam-definitions.html#CareTeam.participant.role">role</a><a name="CareTeam.participant.role"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="ValueSet-us-core-careteam-provider-roles.html">CareTeam Provider Roles</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#extensible" title="To be conformant, the concept in this element SHALL be from the specified value set if any of the codes within the value set can apply to the concept being communicated. If the value set does not cover the concept (based on human review), alternate codings (or, data type allowing, text) may be included instead.">extensible</a>)</td></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck000.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_blank.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-us-core-careteam-definitions.html#CareTeam.participant.member">member</a><a name="CareTeam.participant.member"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-us-core-patient.html">US Core Patient Profile</a> | <a href="StructureDefinition-us-core-practitioner.html">US Core Practitioner</a> | <a href="StructureDefinition-us-core-organization.html">US Core Organization Profile</a> | <a href="http://hl7.org/fhir/STU3/relatedperson.html">RelatedPerson</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam",
"version" : "2.0.0",
"name" : "US Core CareTeam Profile",
"status" : "draft",
"date" : "2016-08-01T00:00:00+10:00",
"publisher" : "HL7 US Realm Steering Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.healthit.gov"
}
]
}
],
"description" : "Defines constraints and extensions on the CareTeam resource for the minimal set of data to query and retrieve a patient's Care Team.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"fhirVersion" : "3.0.1",
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"uri" : "http://unknown.org/Argonaut-DQ-DSTU2",
"name" : "Argonaut-DQ-DSTU2"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "CareTeam",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CareTeam",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "CareTeam",
"path" : "CareTeam",
"short" : "US Core CareTeam Profile",
"definition" : "The US Core CareTeam Profile is based upon the core FHIR CareTeam Resource and created to meet the 2015 Edition Common Clinical Data Set 'Care team member(s)' requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source" : "DomainResource"
}
],
"mustSupport" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "w5",
"map" : "clinical.careprovision"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan"
}
]
},
{
"id" : "CareTeam.id",
"path" : "CareTeam.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isSummary" : true
},
{
"id" : "CareTeam.meta",
"path" : "CareTeam.meta",
"short" : "Metadata about the resource",
"definition" : "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"isSummary" : true
},
{
"id" : "CareTeam.implicitRules",
"path" : "CareTeam.implicitRules",
"short" : "A set of rules under which this content was created",
"definition" : "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment" : "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isSummary" : true
},
{
"id" : "CareTeam.language",
"path" : "CareTeam.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comment" : "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Language"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "CareTeam.text",
"path" : "CareTeam.text",
"short" : "Text summary of the resource, for human interpretation",
"definition" : "A human-readable narrative that contains a summary of the resource, and may 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.",
"comment" : "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"dom-1"
],
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "CareTeam.contained",
"path" : "CareTeam.contained",
"short" : "Contained, inline Resources",
"definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment" : "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "CareTeam.extension",
"path" : "CareTeam.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, 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.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "CareTeam.modifierExtension",
"path" : "CareTeam.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "CareTeam.identifier",
"path" : "CareTeam.identifier",
"short" : "External Ids for this team",
"definition" : "This records identifiers associated with this care team that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "CareTeam.status",
"path" : "CareTeam.status",
"short" : "proposed | active | suspended | inactive | entered-in-error",
"definition" : "Indicates the current state of the care team.",
"comment" : "This element is labeled as a modifier because the status contains the code entered-in-error that marks the care team as not currently valid.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CareTeam.status",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"mustSupport" : true,
"isModifier" : true,
"isSummary" : true,
"binding" : {
"strength" : "required",
"description" : "Indicates whether the team is current , represents future intentions or is now a historical record.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/care-team-status"
}
},
"mapping" : [
{
"identity" : "w5",
"map" : "status"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.status"
}
]
},
{
"id" : "CareTeam.category",
"path" : "CareTeam.category",
"short" : "Type of team",
"definition" : "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.",
"comment" : "There may be multiple axis of categorization and one team may serve multiple purposes.",
"requirements" : "Used for filtering what teams(s) are retrieved and displayed to different types of users.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.category",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamCategory"
}
],
"strength" : "example",
"description" : "Indicates the type of care team.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/care-team-category"
}
},
"mapping" : [
{
"identity" : "w5",
"map" : "class"
}
]
},
{
"id" : "CareTeam.name",
"path" : "CareTeam.name",
"short" : "Name of the team, such as crisis assessment team",
"definition" : "A label for human use intended to distinguish like teams. E.g. the "red" vs. "green" trauma teams.",
"comment" : "The meaning/purpose of the team is conveyed in CareTeam.category. This element may also convey semantics of the team (e.g. "Red trauma team"), but its primary purpose is to distinguish between identical teams in a human-friendly way. ("Team 18735" isn't as friendly . ).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true
},
{
"id" : "CareTeam.subject",
"path" : "CareTeam.subject",
"short" : "Who care team is for",
"definition" : "Identifies the patient or group whose intended care is handled by the team.",
"requirements" : "Allows the team to care for a group (e.g. marriage) therapy.",
"alias" : [
"patient"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "CareTeam.subject",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "who.focus"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.subject"
}
]
},
{
"id" : "CareTeam.context",
"path" : "CareTeam.context",
"short" : "Encounter or episode associated with CareTeam",
"definition" : "The encounter or episode of care that establishes the context for this care team.",
"alias" : [
"encounter"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.context",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "context"
}
]
},
{
"id" : "CareTeam.period",
"path" : "CareTeam.period",
"short" : "Time period team covers",
"definition" : "Indicates when the team did (or is intended to) come into effect and end.",
"requirements" : "Allows tracking what team(s) are in effect at a particular time.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "w5",
"map" : "when.init"
}
]
},
{
"id" : "CareTeam.participant",
"path" : "CareTeam.participant",
"short" : "Members of the team",
"definition" : "Identifies all people and organizations who are expected to be involved in the care team.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "CareTeam.participant",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ctm-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
},
{
"key" : "ctm-1",
"severity" : "error",
"human" : "CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner",
"expression" : "onBehalfOf.exists() implies (member.resolve() is Practitioner)",
"xpath" : "contains(f:member/f:reference/@value, '/Practitioner/') or not(exists(f:onBehalfOf))",
"source" : "CareTeam.participant"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "REL (REL.4 is always the Patient) ( or PRT?)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF]"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.participant"
}
]
},
{
"id" : "CareTeam.participant.id",
"path" : "CareTeam.participant.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "CareTeam.participant.extension",
"path" : "CareTeam.participant.extension",
"short" : "Additional Content defined by implementations",
"definition" : "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "CareTeam.participant.modifierExtension",
"path" : "CareTeam.participant.modifierExtension",
"short" : "Extensions that cannot be ignored",
"definition" : "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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.",
"comment" : "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "CareTeam.participant.role",
"path" : "CareTeam.participant.role",
"short" : "Type of involvement",
"definition" : "Indicates specific responsibility of an individual within the care team, such as "Primary care physician", "Trained social worker counselor", "Caregiver", etc.",
"comment" : "Roles may sometimes be inferred by type of Practitioner. These are relationships that hold only within the context of the care team. General relationships should be handled as properties of the Patient resource directly.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.role",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"mustSupport" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-careteam-provider-roles"
}
}
],
"strength" : "extensible",
"description" : "Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-careteam-provider-roles"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "REL.2 (or PRT-4?)"
},
{
"identity" : "rim",
"map" : ".functionCode"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.participant.role"
}
]
},
{
"id" : "CareTeam.participant.member",
"path" : "CareTeam.participant.member",
"short" : "Who is involved",
"definition" : "The specific person or organization who is participating/expected to participate in the care team.",
"comment" : "Patient only needs to be listed if they have a role other than "subject of care".
Member is optional because some participants may be known only by their role, particularly in draft plans.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.member",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "REL.5 (or PRT-5 : ( PRV-4 {provider participations} ) / PRT-5 : ( PRV-4 {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8?)"
},
{
"identity" : "rim",
"map" : ".role"
},
{
"identity" : "w5",
"map" : "who.actor"
},
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.participant.member"
}
]
},
{
"id" : "CareTeam.participant.onBehalfOf",
"path" : "CareTeam.participant.onBehalfOf",
"short" : "Organization of the practitioner",
"definition" : "The organization of the practitioner.",
"requirements" : "Practitioners can be associated with multiple organizations. This element indicates which organization they were acting on behalf of.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.onBehalfOf",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary" : true
},
{
"id" : "CareTeam.participant.period",
"path" : "CareTeam.participant.period",
"short" : "Time period of participant",
"definition" : "Indicates when the specific member or organization did (or is intended to) come into effect and end.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CareTeam.participant.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
]
},
{
"id" : "CareTeam.reasonCode",
"path" : "CareTeam.reasonCode",
"short" : "Why the care team exists",
"definition" : "Describes why the care team exists.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.reasonCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "CareTeamReason"
}
],
"strength" : "example",
"description" : "Indicates the reason for the care team.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
"mapping" : [
{
"identity" : "w5",
"map" : "why"
}
]
},
{
"id" : "CareTeam.reasonReference",
"path" : "CareTeam.reasonReference",
"short" : "Why the care team exists",
"definition" : "Condition(s) that this care team addresses.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.reasonReference",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping" : [
{
"identity" : "w5",
"map" : "why"
}
]
},
{
"id" : "CareTeam.managingOrganization",
"path" : "CareTeam.managingOrganization",
"short" : "Organization responsible for the care team",
"definition" : "The organization responsible for the care team.",
"requirements" : "Allows for multiple organizations to collaboratively manage cross-organizational, longitudinal care plan.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.managingOrganization",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary" : true
},
{
"id" : "CareTeam.note",
"path" : "CareTeam.note",
"short" : "Comments made about the CareTeam",
"definition" : "Comments made about the CareTeam.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "CareTeam.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "CareTeam",
"path" : "CareTeam",
"short" : "US Core CareTeam Profile",
"definition" : "The US Core CareTeam Profile is based upon the core FHIR CareTeam Resource and created to meet the 2015 Edition Common Clinical Data Set 'Care team member(s)' requirements.",
"mustSupport" : false,
"isModifier" : false,
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan"
}
]
},
{
"id" : "CareTeam.status",
"path" : "CareTeam.status",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"mustSupport" : true,
"isModifier" : false,
"binding" : {
"strength" : "required",
"description" : "Indicates whether the team is current , represents future intentions or is now a historical record.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/care-team-status"
}
},
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.status"
}
]
},
{
"id" : "CareTeam.subject",
"path" : "CareTeam.subject",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
}
],
"mustSupport" : true,
"isModifier" : false,
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.subject"
}
]
},
{
"id" : "CareTeam.participant",
"path" : "CareTeam.participant",
"min" : 1,
"max" : "*",
"mustSupport" : true,
"isModifier" : false,
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.participant"
}
]
},
{
"id" : "CareTeam.participant.role",
"path" : "CareTeam.participant.role",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
}
],
"mustSupport" : true,
"isModifier" : false,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-careteam-provider-roles"
}
}
],
"strength" : "extensible",
"description" : "Indicates specific responsibility of an individual within the care team, such as Primary physician, Team coordinator, Caregiver, etc.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-careteam-provider-roles"
}
},
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.participant.role"
}
]
},
{
"id" : "CareTeam.participant.member",
"path" : "CareTeam.participant.member",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"mustSupport" : true,
"isModifier" : false,
"mapping" : [
{
"identity" : "argonaut-dq-dstu2",
"map" : "CarePlan.participant.member"
}
]
}
]
}
}
US Core: 2.0.0 ®© FHIR Version: 3.0.1 generated on Tue, Dec 4, 2018 10:36+1100.
| History
| Propose a change
