{
"description": "The practitioner(s) referenced in US Core profiles.",
"_filename": "StructureDefinition-us-core-practitioner.json",
"package_name": "hl7.fhir.us.core",
"date": "2016-08-01",
"derivation": "constraint",
"publisher": "HL7 US Realm Steering Committee",
"fhirVersion": "3.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States Minor Outlying Islands (the)"
} ]
} ],
"name": "US Core Practitioner Profile",
"mapping": [ {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD",
"identity": "servd"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
} ],
"abstract": false,
"type": "Practitioner",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "Practitioner",
"min": 0,
"definition": "This is basic constraint on provider for use in US Core resources.",
"short": "US Core Practitioner",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "PRD (as one example)",
"identity": "v2"
}, {
"map": "Role",
"identity": "rim"
}, {
"map": "Provider",
"identity": "servd"
}, {
"map": "administrative.individual",
"identity": "w5"
} ],
"mustSupport": false,
"alias": [ "Provider" ],
"max": "*",
"id": "Practitioner",
"comment": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner"
}
}, {
"path": "Practitioner.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Practitioner.id",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "Practitioner.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Practitioner.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "Practitioner.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Practitioner.implicitRules",
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "Practitioner.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"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
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Practitioner.language",
"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).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "Practitioner.text",
"min": 0,
"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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Practitioner.text",
"condition": [ "dom-1" ],
"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.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Practitioner.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Practitioner.contained",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "Practitioner.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Practitioner.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "Practitioner.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Practitioner.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "Practitioner.identifier",
"requirements": "Either id or name is needed.",
"min": 1,
"definition": "An identifier that applies to this person in this role.",
"short": "A identifier for the person as this agent",
"mapping": [ {
"map": "PRD-7 (or XCN.1)",
"identity": "v2"
}, {
"map": "./id",
"identity": "rim"
}, {
"map": "./Identifiers",
"identity": "servd"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "Practitioner.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.identifier"
},
"isSummary": true
}, {
"path": "Practitioner.identifier.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Practitioner.identifier.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Practitioner.identifier.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Practitioner.identifier.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Practitioner.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "Practitioner.identifier.use",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"path": "Practitioner.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"short": "Description of identifier",
"mapping": [ {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"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"
}
},
"max": "1",
"id": "Practitioner.identifier.type",
"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. \n\nWhere 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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"path": "Practitioner.identifier.system",
"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,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": true,
"max": "1",
"id": "Practitioner.identifier.system",
"comment": "NPI should be used as the identifier system in the US, Tax id is allowed, Local id is allowed in addition to an 'authoritative' identifier.",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"path": "Practitioner.identifier.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"short": "The value that is unique",
"mapping": [ {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"max": "1",
"id": "Practitioner.identifier.value",
"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).",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"path": "Practitioner.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Practitioner.identifier.period",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"path": "Practitioner.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Practitioner.identifier.assigner",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"path": "Practitioner.active",
"requirements": "Need to be able to mark a practitioner record as not to be used because it was created in error.",
"min": 0,
"definition": "Whether this practitioner's record is in active use.",
"short": "Whether this practitioner's record is in active use",
"mapping": [ {
"map": "./statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": true,
"max": "1",
"id": "Practitioner.active",
"comment": "Default is true. \r\rIf 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.",
"base": {
"max": "1",
"min": 0,
"path": "Practitioner.active"
},
"isSummary": true
}, {
"path": "Practitioner.name",
"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,
"definition": "The name(s) associated with the practitioner.",
"short": "The name(s) associated with the practitioner",
"mapping": [ {
"map": "XCN Components",
"identity": "v2"
}, {
"map": "./name",
"identity": "rim"
}, {
"map": "./PreferredName (GivenNames, FamilyName, TitleCode)",
"identity": "servd"
} ],
"type": [ {
"code": "HumanName"
} ],
"mustSupport": true,
"max": "1",
"id": "Practitioner.name",
"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.\r\rIn general select the value to be used in the ResourceReference.display based on this:\r\r1. There is more than 1 name\r2. Use = usual\r3. Period is current to the date of the usage\r4. Use = official\r5. Other order as decided by internal business rules.",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.name"
},
"isSummary": true
}, {
"path": "Practitioner.name.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Practitioner.name.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Practitioner.name.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Practitioner.name.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Practitioner.name.use",
"requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min": 0,
"definition": "Identifies the purpose for this name.",
"isModifier": true,
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"mapping": [ {
"map": "XPN.7, but often indicated by which field contains the name",
"identity": "v2"
}, {
"map": "unique(./use)",
"identity": "rim"
}, {
"map": "./NamePurpose",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NameUse"
} ],
"description": "The use of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"max": "1",
"id": "Practitioner.name.use",
"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.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.use"
},
"isSummary": true
}, {
"path": "Practitioner.name.text",
"requirements": "A renderable, unencoded form.",
"min": 0,
"definition": "A full text representation of the name.",
"short": "Text representation of the full name",
"mapping": [ {
"map": "implied by XPN.11",
"identity": "v2"
}, {
"map": "./formatted",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Practitioner.name.text",
"comment": "Can provide both a text representation and structured parts.",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.text"
},
"isSummary": true
}, {
"path": "Practitioner.name.family",
"min": 1,
"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.",
"short": "Family name (often called 'Surname')",
"mapping": [ {
"map": "XPN.1/FN.1",
"identity": "v2"
}, {
"map": "./part[partType = FAM]",
"identity": "rim"
}, {
"map": "./FamilyName",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": true,
"alias": [ "surname" ],
"max": "1",
"id": "Practitioner.name.family",
"comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.family"
},
"isSummary": true
}, {
"path": "Practitioner.name.given",
"min": 0,
"definition": "Given name.",
"short": "Given names (not always 'first'). Includes middle names",
"mapping": [ {
"map": "XPN.2 + XPN.3",
"identity": "v2"
}, {
"map": "./part[partType = GIV]",
"identity": "rim"
}, {
"map": "./GivenNames",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"alias": [ "first name", "middle name" ],
"max": "*",
"id": "Practitioner.name.given",
"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.",
"orderMeaning": "Given Names appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.given"
},
"isSummary": true
}, {
"path": "Practitioner.name.prefix",
"min": 0,
"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.",
"short": "Parts that come before the name",
"mapping": [ {
"map": "XPN.5",
"identity": "v2"
}, {
"map": "./part[partType = PFX]",
"identity": "rim"
}, {
"map": "./TitleCode",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Practitioner.name.prefix",
"orderMeaning": "Prefixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.prefix"
},
"isSummary": true
}, {
"path": "Practitioner.name.suffix",
"min": 0,
"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.",
"short": "Parts that come after the name",
"mapping": [ {
"map": "XPN/4",
"identity": "v2"
}, {
"map": "./part[partType = SFX]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "*",
"id": "Practitioner.name.suffix",
"orderMeaning": "Suffixes appear in the correct order for presenting the name",
"base": {
"max": "*",
"min": 0,
"path": "HumanName.suffix"
},
"isSummary": true
}, {
"path": "Practitioner.name.period",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"definition": "Indicates the period of time when this name was valid for the named person.",
"short": "Time period when name was/is in use",
"mapping": [ {
"map": "XPN.13 + XPN.14",
"identity": "v2"
}, {
"map": "./usablePeriod[type=\"IVL\"]",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Practitioner.name.period",
"base": {
"max": "1",
"min": 0,
"path": "HumanName.period"
},
"isSummary": true
}, {
"path": "Practitioner.telecom",
"requirements": "Need to know how to reach a practitioner independent to any roles the practitioner may have.",
"min": 0,
"definition": "A contact detail for the practitioner, e.g. a telephone number or an email address.",
"short": "A contact detail for the practitioner (that apply to all roles)",
"mapping": [ {
"map": "PRT-15, STF-10, ROL-12",
"identity": "v2"
}, {
"map": "./telecom",
"identity": "rim"
}, {
"map": "./ContactPoints",
"identity": "servd"
} ],
"type": [ {
"code": "ContactPoint"
} ],
"max": "*",
"id": "Practitioner.telecom",
"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\r\rThese typically will have home numbers, or mobile numbers that are not role specific.",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.telecom"
},
"isSummary": true
}, {
"path": "Practitioner.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,
"definition": "Address(es) of the practitioner that are not role specific (typically home address). \rWork addresses are not typically entered in this property as they are usually role dependent.",
"short": "Address(es) of the practitioner that are not role specific (typically home address)",
"mapping": [ {
"map": "ORC-24, STF-11, ROL-11, PRT-14",
"identity": "v2"
}, {
"map": "./addr",
"identity": "rim"
}, {
"map": "./Addresses",
"identity": "servd"
} ],
"type": [ {
"code": "Address"
} ],
"max": "*",
"id": "Practitioner.address",
"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).",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.address"
},
"isSummary": true
}, {
"path": "Practitioner.gender",
"requirements": "Needed to address the person correctly.",
"min": 0,
"definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"short": "male | female | other | unknown",
"mapping": [ {
"map": "STF-5",
"identity": "v2"
}, {
"map": "./administrativeGender",
"identity": "rim"
}, {
"map": "./GenderCode",
"identity": "servd"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "AdministrativeGender"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"max": "1",
"id": "Practitioner.gender",
"base": {
"max": "1",
"min": 0,
"path": "Practitioner.gender"
},
"isSummary": true
}, {
"path": "Practitioner.birthDate",
"requirements": "Needed for identification.",
"min": 0,
"definition": "The date of birth for the practitioner.",
"short": "The date on which the practitioner was born",
"mapping": [ {
"map": "STF-6",
"identity": "v2"
}, {
"map": "./birthTime",
"identity": "rim"
}, {
"map": "(not represented in ServD)",
"identity": "servd"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Practitioner.birthDate",
"base": {
"max": "1",
"min": 0,
"path": "Practitioner.birthDate"
},
"isSummary": true
}, {
"path": "Practitioner.photo",
"requirements": "Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.",
"min": 0,
"definition": "Image of the person.",
"short": "Image of the person",
"mapping": [ {
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value",
"identity": "rim"
}, {
"map": "./ImageURI (only supports the URI reference)",
"identity": "servd"
} ],
"type": [ {
"code": "Attachment"
} ],
"max": "*",
"id": "Practitioner.photo",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.photo"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Practitioner.qualification",
"min": 0,
"definition": "Qualifications obtained by training and certification.",
"short": "Qualifications obtained by training and certification",
"mapping": [ {
"map": "CER?",
"identity": "v2"
}, {
"map": ".playingEntity.playingRole[classCode=QUAL].code",
"identity": "rim"
}, {
"map": "./Qualifications",
"identity": "servd"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Practitioner.qualification",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.qualification"
}
}, {
"path": "Practitioner.qualification.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Practitioner.qualification.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "Practitioner.qualification.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Practitioner.qualification.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "Practitioner.qualification.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Practitioner.qualification.modifierExtension",
"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.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "Practitioner.qualification.identifier",
"requirements": "Often, specific identities are assigned for the qualification.",
"min": 0,
"definition": "An identifier that applies to this person's qualification in this role.",
"short": "An identifier for this qualification for the practitioner",
"mapping": [ {
"map": ".playingEntity.playingRole[classCode=QUAL].id",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Practitioner.qualification.identifier",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.qualification.identifier"
}
}, {
"path": "Practitioner.qualification.code",
"min": 1,
"definition": "Coded representation of the qualification.",
"short": "Coded representation of the qualification",
"mapping": [ {
"map": ".playingEntity.playingRole[classCode=QUAL].code",
"identity": "rim"
}, {
"map": "./Qualifications.Value",
"identity": "servd"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Qualification"
} ],
"description": "Specific qualification the practitioner has to provide a service",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v2-2.7-0360"
}
},
"max": "1",
"id": "Practitioner.qualification.code",
"base": {
"max": "1",
"min": 1,
"path": "Practitioner.qualification.code"
}
}, {
"path": "Practitioner.qualification.period",
"requirements": "Qualifications are often for a limited period of time, and can be revoked.",
"min": 0,
"definition": "Period during which the qualification is valid.",
"short": "Period during which the qualification is valid",
"mapping": [ {
"map": ".playingEntity.playingRole[classCode=QUAL].effectiveTime",
"identity": "rim"
}, {
"map": "./Qualifications.StartDate and ./Qualifications.EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Practitioner.qualification.period",
"base": {
"max": "1",
"min": 0,
"path": "Practitioner.qualification.period"
}
}, {
"path": "Practitioner.qualification.issuer",
"min": 0,
"definition": "Organization that regulates and issues the qualification.",
"short": "Organization that regulates and issues the qualification",
"mapping": [ {
"map": ".playingEntity.playingRole[classCode=QUAL].scoper",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "1",
"id": "Practitioner.qualification.issuer",
"base": {
"max": "1",
"min": 0,
"path": "Practitioner.qualification.issuer"
}
}, {
"path": "Practitioner.communication",
"requirements": "Knowing which language a practitioner speaks can help in facilitating communication with patients.",
"min": 0,
"definition": "A language the practitioner is able to use in patient communication.",
"short": "A language the practitioner is able to use in patient communication",
"mapping": [ {
"map": "PID-15, NK1-20, LAN-2",
"identity": "v2"
}, {
"map": "./languageCommunication",
"identity": "rim"
}, {
"map": "./Languages.LanguageSpokenCode",
"identity": "servd"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"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
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "*",
"id": "Practitioner.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.",
"base": {
"max": "*",
"min": 0,
"path": "Practitioner.communication"
}
} ]
},
"status": "draft",
"id": "28606307-3fca-4b44-b1ae-6c1592828a3b",
"kind": "resource",
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
"version": "1.1.0",
"differential": {
"element": [ {
"id": "Practitioner",
"path": "Practitioner",
"alias": [ "Provider" ],
"short": "US Core Practitioner",
"definition": "This is basic constraint on provider for use in US Core resources.",
"isModifier": false,
"mustSupport": false
}, {
"id": "Practitioner.identifier",
"max": "*",
"min": 1,
"path": "Practitioner.identifier",
"type": [ {
"code": "Identifier"
} ],
"isModifier": false,
"mustSupport": true,
"requirements": "Either id or name is needed."
}, {
"id": "Practitioner.identifier.system",
"max": "1",
"min": 1,
"path": "Practitioner.identifier.system",
"type": [ {
"code": "uri"
} ],
"comment": "NPI should be used as the identifier system in the US, Tax id is allowed, Local id is allowed in addition to an 'authoritative' identifier.",
"isModifier": false,
"mustSupport": true
}, {
"id": "Practitioner.identifier.value",
"max": "1",
"min": 1,
"path": "Practitioner.identifier.value",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": true
}, {
"id": "Practitioner.name",
"max": "1",
"min": 1,
"path": "Practitioner.name",
"type": [ {
"code": "HumanName"
} ],
"isModifier": false,
"mustSupport": true
}, {
"id": "Practitioner.name.family",
"max": "1",
"min": 1,
"path": "Practitioner.name.family",
"type": [ {
"code": "string"
} ],
"isModifier": false,
"mustSupport": true
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.healthit.gov",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}