US Core Implementation Guide (Release 1)
This page is part of the US Core (v1.0.0: STU1) 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 
{
"resourceType" : "StructureDefinition",
"id" : "us-core-practitioner",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</a></p><p><b>version</b>: 1.0.0</p><p><b>name</b>: US Core Practitioner Profile</p><p><b>status</b>: DRAFT</p><p><b>date</b>: 01/08/2016</p><p><b>publisher</b>: HL7 US Realm Steering Committee</p><p><b>contact</b>: </p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner">http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</a></p><p><b>version</b>: 1.0.0</p><p><b>name</b>: US Core Practitioner Profile</p><p><b>status</b>: DRAFT</p><p><b>date</b>: 01/08/2016</p><p><b>publisher</b>: HL7 US Realm Steering Committee</p><p><b>contact</b>: </p><p><b>fhirVersion</b>: 3.0.0</p><blockquote><p><b>mapping</b></p><p><b>identity</b>: v2</p><p><b>uri</b>: <a href="http://hl7.org/v2">http://hl7.org/v2</a></p><p><b>name</b>: HL7 v2 Mapping</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: rim</p><p><b>uri</b>: <a href="http://hl7.org/v3">http://hl7.org/v3</a></p><p><b>name</b>: RIM Mapping</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: servd</p><p><b>uri</b>: <a href="http://www.omg.org/spec/ServD/1.0/">http://www.omg.org/spec/ServD/1.0/</a></p><p><b>name</b>: ServD</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: w5</p><p><b>uri</b>: <a href="http://hl7.org/fhir/w5">http://hl7.org/fhir/w5</a></p><p><b>name</b>: W5 Mapping</p></blockquote><p><b>kind</b>: RESOURCE</p><p><b>abstract</b>: false</p><p><b>type</b>: Practitioner</p><p><b>baseDefinition</b>: <a href="http://hl7.org/fhir/StructureDefinition/Practitioner">http://hl7.org/fhir/StructureDefinition/Practitioner</a></p><p><b>derivation</b>: CONSTRAINT</p><h3>Snapshots</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table><h3>Differentials</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
"version" : "1.0.0",
"name" : "US Core Practitioner Profile",
"status" : "draft",
"date" : "2016-08-01",
"publisher" : "HL7 US Realm Steering Committee",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.healthit.gov"
}
]
}
],
"fhirVersion" : "3.0.0",
"mapping" : [
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "servd",
"uri" : "http://www.omg.org/spec/ServD/1.0/",
"name" : "ServD"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Practitioner",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Practitioner",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Practitioner:uscorepractitioner",
"path" : "Practitioner",
"sliceName" : "USCorePractitioner",
"short" : "US Core Practitioner",
"definition" : "This is basic constraint on provider for use in US Core resources.",
"comment" : "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?",
"alias" : [
"Provider"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner",
"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" : "v2",
"map" : "PRD (as one example)"
},
{
"identity" : "rim",
"map" : "Role"
},
{
"identity" : "servd",
"map" : "Provider"
},
{
"identity" : "w5",
"map" : "administrative.individual"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.id",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.meta",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.implicitRules",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.language",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.text",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.contained",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.extension",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.modifierExtension",
"path" : "Practitioner.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" : "Practitioner:uscorepractitioner.identifier",
"path" : "Practitioner.identifier",
"short" : "A identifier for the person as this agent",
"definition" : "An identifier that applies to this person in this role.",
"requirements" : "Either id or name is needed.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Practitioner.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "PRD-7 (or XCN.1)"
},
{
"identity" : "rim",
"map" : "./id"
},
{
"identity" : "servd",
"map" : "./Identifiers"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.identifier.id",
"path" : "Practitioner.identifier.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" : "Practitioner:uscorepractitioner.identifier.extension",
"path" : "Practitioner.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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" : "Practitioner:uscorepractitioner.identifier.use",
"path" : "Practitioner.identifier.use",
"short" : "usual | official | temp | secondary (If known)",
"definition" : "The purpose of this identifier.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.identifier.type",
"path" : "Practitioner.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment" : "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.
Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.identifier.system",
"path" : "Practitioner.identifier.system",
"short" : "NPI could be used as the identifier system in the US.",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "NPI could be used as the identifier system in the US.",
"requirements" : "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
},
{
"label" : "General",
"valueUri" : "NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.identifier.value",
"path" : "Practitioner.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment" : "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.identifier.period",
"path" : "Practitioner.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.identifier.assigner",
"path" : "Practitioner.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"comment" : "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.active",
"path" : "Practitioner.active",
"short" : "Whether this practitioner's record is in active use",
"definition" : "Whether this practitioner's record is in active use.",
"comment" : "Default is true.
If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.",
"requirements" : "Need to be able to mark a practitioner record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.active",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"defaultValueBoolean" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "./statusCode"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name",
"path" : "Practitioner.name",
"short" : "The name(s) associated with the practitioner",
"definition" : "The name(s) associated with the practitioner.",
"comment" : "The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate.
In general select the value to be used in the ResourceReference.display based on this:
1. There is more than 1 name
2. Use = usual
3. Period is current to the date of the usage
4. Use = official
5. Other order as decided by internal business rules.",
"requirements" : "The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Practitioner.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "HumanName"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XCN Components"
},
{
"identity" : "rim",
"map" : "./name"
},
{
"identity" : "servd",
"map" : "./PreferredName (GivenNames, FamilyName, TitleCode)"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.id",
"path" : "Practitioner.name.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" : "Practitioner:uscorepractitioner.name.extension",
"path" : "Practitioner.name.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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" : "Practitioner:uscorepractitioner.name.use",
"path" : "Practitioner.name.use",
"short" : "usual | official | temp | nickname | anonymous | old | maiden",
"definition" : "Identifies the purpose for this name.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"requirements" : "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NameUse"
}
],
"strength" : "required",
"description" : "The use of a human name",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/name-use"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "XPN.7, but often indicated by which field contains the name"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./NamePurpose"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.text",
"path" : "Practitioner.name.text",
"short" : "Text representation of the full name",
"definition" : "A full text representation of the name.",
"comment" : "Can provide both a text representation and structured parts.",
"requirements" : "A renderable, unencoded form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "implied by XPN.11"
},
{
"identity" : "rim",
"map" : "./formatted"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.family",
"path" : "Practitioner.name.family",
"short" : "Family name (often called 'Surname')",
"definition" : "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"comment" : "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"alias" : [
"surname"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "HumanName.family",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XPN.1/FN.1"
},
{
"identity" : "rim",
"map" : "./part[partType = FAM]"
},
{
"identity" : "servd",
"map" : "./FamilyName"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.given",
"path" : "Practitioner.name.given",
"short" : "Given names (not always 'first'). Includes middle names",
"definition" : "Given name.",
"comment" : "If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.",
"alias" : [
"first name",
"middle name"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.given",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Given Names appear in the correct order for presenting the name",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XPN.2 + XPN.3"
},
{
"identity" : "rim",
"map" : "./part[partType = GIV]"
},
{
"identity" : "servd",
"map" : "./GivenNames"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.prefix",
"path" : "Practitioner.name.prefix",
"short" : "Parts that come before the name",
"definition" : "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.prefix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Prefixes appear in the correct order for presenting the name",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XPN.5"
},
{
"identity" : "rim",
"map" : "./part[partType = PFX]"
},
{
"identity" : "servd",
"map" : "./TitleCode"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.suffix",
"path" : "Practitioner.name.suffix",
"short" : "Parts that come after the name",
"definition" : "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.suffix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Suffixes appear in the correct order for presenting the name",
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XPN/4"
},
{
"identity" : "rim",
"map" : "./part[partType = SFX]"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.name.period",
"path" : "Practitioner.name.period",
"short" : "Time period when name was/is in use",
"definition" : "Indicates the period of time when this name was valid for the named person.",
"requirements" : "Allows names to be placed in historical context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "XPN.13 + XPN.14"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.telecom",
"path" : "Practitioner.telecom",
"short" : "A contact detail for the practitioner (that apply to all roles)",
"definition" : "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"comment" : "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification
These typically will have home numbers, or mobile numbers that are not role specific.",
"requirements" : "Need to know how to reach a practitioner independent to any roles the practitioner may have.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "PRT-15, STF-10, ROL-12"
},
{
"identity" : "rim",
"map" : "./telecom"
},
{
"identity" : "servd",
"map" : "./ContactPoints"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.address",
"path" : "Practitioner.address",
"short" : "Address(es) of the practitioner that are not role specific (typically home address)",
"definition" : "Address(es) of the practitioner that are not role specific (typically home address).
Work addresses are not typically entered in this property as they are usually role dependent.",
"comment" : "The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).",
"requirements" : "The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.address",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Address"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity" : "rim",
"map" : "./addr"
},
{
"identity" : "servd",
"map" : "./Addresses"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.gender",
"path" : "Practitioner.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"requirements" : "Needed to address the person correctly.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.gender",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "STF-5"
},
{
"identity" : "rim",
"map" : "./administrativeGender"
},
{
"identity" : "servd",
"map" : "./GenderCode"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.birthDate",
"path" : "Practitioner.birthDate",
"short" : "The date on which the practitioner was born",
"definition" : "The date of birth for the practitioner.",
"requirements" : "Needed for identification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "STF-6"
},
{
"identity" : "rim",
"map" : "./birthTime"
},
{
"identity" : "servd",
"map" : "(not represented in ServD)"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.photo",
"path" : "Practitioner.photo",
"short" : "Image of the person",
"definition" : "Image of the person.",
"requirements" : "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.photo",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Attachment"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "./subjectOf/ObservationEvent[code="photo"]/value"
},
{
"identity" : "servd",
"map" : "./ImageURI (only supports the URI reference)"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.qualification",
"path" : "Practitioner.qualification",
"short" : "Qualifications obtained by training and certification",
"definition" : "Qualifications obtained by training and certification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.qualification",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "children().count() > id.count()",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "CER?"
},
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].code"
},
{
"identity" : "servd",
"map" : "./Qualifications"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.qualification.id",
"path" : "Practitioner.qualification.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" : "Practitioner:uscorepractitioner.qualification.extension",
"path" : "Practitioner.qualification.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" : "Practitioner:uscorepractitioner.qualification.modifierExtension",
"path" : "Practitioner.qualification.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" : "Practitioner:uscorepractitioner.qualification.identifier",
"path" : "Practitioner.qualification.identifier",
"short" : "An identifier for this qualification for the practitioner",
"definition" : "An identifier that applies to this person's qualification in this role.",
"requirements" : "Often, specific identities are assigned for the qualification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.qualification.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].id"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.qualification.code",
"path" : "Practitioner.qualification.code",
"short" : "Coded representation of the qualification",
"definition" : "Coded representation of the qualification.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Practitioner.qualification.code",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "Qualification"
}
],
"strength" : "example",
"description" : "Specific qualification the practitioner has to provide a service",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/v2-2.7-0360"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].code"
},
{
"identity" : "servd",
"map" : "./Qualifications.Value"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.qualification.period",
"path" : "Practitioner.qualification.period",
"short" : "Period during which the qualification is valid",
"definition" : "Period during which the qualification is valid.",
"requirements" : "Qualifications are often for a limited period of time, and can be revoked.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.qualification.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].effectiveTime"
},
{
"identity" : "servd",
"map" : "./Qualifications.StartDate and ./Qualifications.EndDate"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.qualification.issuer",
"path" : "Practitioner.qualification.issuer",
"short" : "Organization that regulates and issues the qualification",
"definition" : "Organization that regulates and issues the qualification.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Practitioner.qualification.issuer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".playingEntity.playingRole[classCode=QUAL].scoper"
}
]
},
{
"id" : "Practitioner:uscorepractitioner.communication",
"path" : "Practitioner.communication",
"short" : "A language the practitioner is able to use in patient communication",
"definition" : "A language the practitioner is able to use in patient communication.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Knowing which language a practitioner speaks can help in facilitating communication with patients.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Practitioner.communication",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"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"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "PID-15, NK1-20, LAN-2"
},
{
"identity" : "rim",
"map" : "./languageCommunication"
},
{
"identity" : "servd",
"map" : "./Languages.LanguageSpokenCode"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Practitioner:uscorepractitioner",
"path" : "Practitioner",
"sliceName" : "USCorePractitioner",
"short" : "US Core Practitioner",
"definition" : "This is basic constraint on provider for use in US Core resources.",
"alias" : [
"Provider"
],
"mustSupport" : false,
"isModifier" : false
},
{
"id" : "Practitioner:uscorepractitioner.identifier",
"path" : "Practitioner.identifier",
"requirements" : "Either id or name is needed.",
"min" : 1,
"max" : "*",
"type" : [
{
"code" : "Identifier"
}
],
"mustSupport" : true,
"isModifier" : false
},
{
"id" : "Practitioner:uscorepractitioner.identifier.system",
"path" : "Practitioner.identifier.system",
"short" : "NPI could be used as the identifier system in the US.",
"comment" : "NPI could be used as the identifier system in the US.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier"
}
],
"mustSupport" : true,
"isModifier" : false
},
{
"id" : "Practitioner:uscorepractitioner.identifier.value",
"path" : "Practitioner.identifier.value",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "string"
}
],
"mustSupport" : true,
"isModifier" : false
},
{
"id" : "Practitioner:uscorepractitioner.name",
"path" : "Practitioner.name",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "HumanName"
}
],
"mustSupport" : true,
"isModifier" : false
},
{
"id" : "Practitioner:uscorepractitioner.name.family",
"path" : "Practitioner.name.family",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "string"
}
],
"mustSupport" : true,
"isModifier" : false
}
]
}
}
US Core © v1.0.0 (STU1) based on FHIR Release 3 (STU; 3.0.0) generated on Tue, Mar 21, 2017 11:28+1100. |
