This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
StructureDefinition for ProviderPractitioner captures the demographic and preofessional information of a health care provider/practitioner.
{ "resourceType": "StructureDefinition", "id": "hspc-provpract", "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "url": "http://hl7.org/fhir/StructureDefinition/hspc-provpract", "name": "HSPC ProviderPractitioner", "status": "draft", "publisher": "HSPC", "contact": [ { "telecom": [ { "system": "other", "value": "http://healthcaresoa.org" } ] } ], "date": "2015-05-13", "description": "ProviderPractitioner captures the demographic and preofessional information of a health care provider/practitioner.", "fhirVersion": "1.2.0", "kind": "resource", "constrainedType": "Practitioner", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/qicore-practitioner", "snapshot": { "element": [ { "path": "Practitioner", "name": "hspc-provpract", "short": "A person with a formal responsibility in the provisioning of healthcare or related services", "definition": "A person who is directly or indirectly involved in the provisioning of healthcare.", "comments": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?", "min": 0, "max": "*", "base": { "path": "Practitioner", "min": 0, "max": "*" }, "type": [ { "code": "Practitioner" } ], "mapping": [ { "identity": "v2", "map": "PRD (as one example)" }, { "identity": "rim", "map": "Role" }, { "identity": "servd", "map": "Provider" }, { "identity": "w5", "map": "administrative.individual" }, { "identity": "qdm", "map": "Provider Characteristic" } ] }, { "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.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "base": { "path": "Practitioner.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "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": "Practitioner.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "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.", "comments": "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 as much as possible.", "min": 0, "max": "1", "base": { "path": "Practitioner.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "path": "Practitioner.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comments": "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": "Practitioner.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "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.", "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "Practitioner.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "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.", "comments": "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": "Practitioner.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Practitioner.extension", "name": "Practitioner.classification", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Practitioner.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/practitioner-classification" ] } ], "mapping": [ { "identity": "qidam", "map": "Not in QIDAM, but recognized as important. While there is practitionerRole, that may refer more to something like “attending” vs. “consultant” physician, whereas the classification would be useful for classifying the practitioner to things like “Physician”, “Resident”, “Pharmacist”, “Nurse”, “PA”. This could then determine whether the practitioner should receive a particular CDS." } ] }, { "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.", "comments": "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": "Practitioner.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Practitioner.identifier", "short": "A identifier for the person as this agent", "definition": "An identifier that applies to this person in this role.", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "max": "*", "base": { "path": "Practitioner.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-7 (or XCN.1)" }, { "identity": "rim", "map": "./id" }, { "identity": "servd", "map": "./Identifiers" }, { "identity": "w5", "map": "id" } ] }, { "path": "Practitioner.active", "short": "Whether this practitioner's record is in active use", "definition": "Whether this practitioner's record is in active use.", "comments": "Default is true. \n\nIf 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" } ] }, { "path": "Practitioner.name", "short": "A name associated with the person", "definition": "A name associated with the person.", "requirements": "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.", "min": 0, "max": "1", "base": { "path": "Practitioner.name", "min": 0, "max": "1" }, "type": [ { "code": "HumanName" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XCN Components" }, { "identity": "rim", "map": "./name" }, { "identity": "servd", "map": "./PreferredName (GivenNames, FamilyName, TitleCode)" } ] }, { "path": "Practitioner.telecom", "short": "A contact detail for the practitioner", "definition": "A contact detail for the practitioner, e.g. a telephone number or an email address.", "comments": "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.", "requirements": "Need to know how to reach a practitioner.", "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" } ] }, { "path": "Practitioner.telecom.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "ContactPoint.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.telecom.extension", "name": "PreferenceIndicator", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "ContactPoint.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-preferred" ] } ] }, { "path": "Practitioner.telecom.system", "short": "phone | fax | email | pager | other", "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "min": 0, "max": "1", "base": { "path": "ContactPoint.system", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "condition": [ "cpt-2" ], "isSummary": true, "binding": { "strength": "required", "description": "Telecommunications form for contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-system" } }, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ] }, { "path": "Practitioner.telecom.value", "short": "The actual contact point details", "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "comments": "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "min": 0, "max": "1", "base": { "path": "ContactPoint.value", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ] }, { "path": "Practitioner.telecom.use", "short": "home | work | temp | old | mobile - purpose of this contact point", "definition": "Identifies the purpose for the contact point.", "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "min": 0, "max": "1", "base": { "path": "ContactPoint.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Use of contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/contact-point-use" } }, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ] }, { "path": "Practitioner.telecom.rank", "short": "Specify preferred order of use (1 = highest)", "definition": "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.", "comments": "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.", "min": 0, "max": "1", "base": { "path": "ContactPoint.rank", "min": 0, "max": "1" }, "type": [ { "code": "positiveInt" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "n/a" }, { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.telecom.period", "short": "Time period when the contact point was/is in use", "definition": "Time period when the contact point was/is in use.", "min": 0, "max": "1", "base": { "path": "ContactPoint.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./useablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "path": "Practitioner.address", "short": "Where practitioner can be found/visited", "definition": "The postal address where the practitioner can be found or visited or to which mail can be delivered.", "requirements": "Need to keep track where the practitioner can found during work or for directing mail.", "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" } ] }, { "path": "Practitioner.address.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Address.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.address.extension", "name": "PrimaryIndicator", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Address.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator" ] } ], "binding": { "strength": "preferred", "description": "The set of values to indicate affirmative or negative", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0136" } } }, { "path": "Practitioner.address.use", "short": "home | work | temp | old - purpose of this address", "definition": "The purpose of this address.", "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "requirements": "Allows an appropriate address to be chosen from a list of many.", "min": 0, "max": "1", "base": { "path": "Address.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "exampleCode": "home", "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "The use of an address", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-use" } }, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] }, { "path": "Practitioner.address.type", "short": "postal | physical | both", "definition": "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.", "min": 0, "max": "1", "base": { "path": "Address.type", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "exampleCode": "both", "isSummary": true, "binding": { "strength": "required", "description": "The type of an address (physical / postal)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/address-type" } }, "mapping": [ { "identity": "vcard", "map": "address type parameter" }, { "identity": "v2", "map": "XAD.18" }, { "identity": "rim", "map": "unique(./use)" } ] }, { "path": "Practitioner.address.text", "short": "Text representation of the address", "definition": "A full text representation of the address.", "comments": "Can provide both a text representation and parts.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": { "path": "Address.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "exampleString": "137 Nowhere Street, Erewhon 9132", "isSummary": true, "mapping": [ { "identity": "vcard", "map": "address label parameter" }, { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" } ] }, { "path": "Practitioner.address.line", "short": "Street name, number, direction & P.O. Box etc.", "definition": "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.", "requirements": "home | work | temp | old - purpose of this address.", "min": 0, "max": "*", "base": { "path": "Address.line", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "exampleString": "137 Nowhere Street", "isSummary": true, "mapping": [ { "identity": "vcard", "map": "street" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "path": "Practitioner.address.city", "short": "Name of city, town etc.", "definition": "The name of the city, town, village or other community or delivery center.", "alias": [ "Municpality" ], "min": 0, "max": "1", "base": { "path": "Address.city", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "exampleString": "Erewhon", "isSummary": true, "mapping": [ { "identity": "vcard", "map": "locality" }, { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "path": "Practitioner.address.district", "short": "District name (aka county)", "definition": "The name of the administrative area (county).", "comments": "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.", "alias": [ "County" ], "min": 0, "max": "1", "base": { "path": "Address.district", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "exampleString": "Madison", "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.9" }, { "identity": "rim", "map": "AD.part[parttype = CNT | CPA]" } ] }, { "path": "Practitioner.address.state", "short": "Sub-unit of country (abbreviations ok)", "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "base": { "path": "Address.state", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "vcard", "map": "region" }, { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "servd", "map": "./Region" } ] }, { "path": "Practitioner.address.postalCode", "short": "Postal code for area", "definition": "A postal code designating a region defined by the postal service.", "alias": [ "Zip" ], "min": 0, "max": "1", "base": { "path": "Address.postalCode", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "exampleString": "9132", "isSummary": true, "mapping": [ { "identity": "vcard", "map": "code" }, { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "path": "Practitioner.address.country", "short": "Country (can be ISO 3166 3 letter code)", "definition": "Country - a nation as commonly understood or generally accepted.", "comments": "ISO 3166 3 letter codes can be used in place of a full country name.", "min": 0, "max": "1", "base": { "path": "Address.country", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "vcard", "map": "country" }, { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "servd", "map": "./Country" } ] }, { "path": "Practitioner.address.period", "short": "Time period when address was/is in use", "definition": "Time period when address was/is in use.", "requirements": "Allows addresses to be placed in historical context.", "min": 0, "max": "1", "base": { "path": "Address.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "examplePeriod": { "start": "2010-03-23", "end": "2010-07-01" }, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "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" } ], "mustSupport": true, "isSummary": true, "binding": { "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" } ] }, { "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)" } ] }, { "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)" } ] }, { "path": "Practitioner.practitionerRole", "slicing": { "discriminator": [ "Practitioner.practitionerRole.managingOrganization", "Practitioner.practitionerRole.role" ], "ordered": false, "rules": "open" }, "short": "Roles/organizations the practitioner is associated with", "definition": "The list of roles/organizations that the practitioner is associated with.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": ".(Role)" } ] }, { "path": "Practitioner.practitionerRole", "name": "PractitionerRole", "short": "Roles/organizations the practitioner is associated with", "definition": "The list of roles/organizations that the practitioner is associated with.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": ".(Role)" } ] }, { "path": "Practitioner.practitionerRole.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.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.", "comments": "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": "Practitioner.practitionerRole.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.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.", "comments": "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": "Practitioner.practitionerRole.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Practitioner.practitionerRole.managingOrganization", "short": "Organization where the roles are performed", "definition": "The organization where the Practitioner performs the roles associated.", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.managingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-organization" ] } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "scopingOrganization" } ] }, { "path": "Practitioner.practitionerRole.role", "short": "Roles which this practitioner may perform", "definition": "Roles which this practitioner is authorized to perform for the organization.", "comments": "A person may have more than one role. At least one role is required.", "requirements": "Need to know what authority the practitioner has - what can they do?", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.role", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "preferred", "description": "A set of codes that describe the general practice category for a provider.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-providerPractitionerType" } }, "mapping": [ { "identity": "v2", "map": "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17" }, { "identity": "rim", "map": "./code" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" } ] }, { "path": "Practitioner.practitionerRole.specialty", "short": "Specific specialty of the practitioner", "definition": "Specific specialty of the practitioner.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.specialty", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "preferred", "description": "A set of codes that describe the specific specialty in which a provider practices.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-providerPractitionerSpecialty" } }, "mapping": [ { "identity": "v2", "map": "PRA-5" }, { "identity": "rim", "map": "indirectAuthority/QualifiedEntity[code < Speciality]/code" }, { "identity": "servd", "map": "./Specialty" } ] }, { "path": "Practitioner.practitionerRole.specialty.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "CodeableConcept.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.specialty.extension", "name": "Practitioner.practitionerRole.specialty.primaryInd", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "CodeableConcept.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd" ] } ], "mapping": [ { "identity": "qidam", "map": "Not in QIDAM, but recognized as important. The primary specialty could drive the order sets or order preferences that are provided as default in an order entry system. Also, a population health management system may want to manage patients with heart failure who are managed by a provider whose primary specialty is cardiology." } ] }, { "path": "Practitioner.practitionerRole.specialty.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" } ] }, { "path": "Practitioner.practitionerRole.specialty.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comments": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }, { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" } ] }, { "path": "Practitioner.practitionerRole.period", "short": "The period during which the practitioner is authorized to perform in these role(s)", "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-8/9 / PRA-5.4" }, { "identity": "rim", "map": "./effectiveTime" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "Practitioner.practitionerRole.location", "short": "The location(s) at which this practitioner provides care", "definition": "The location(s) at which this practitioner provides care.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.location", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-location" ] } ], "mapping": [ { "identity": "rim", "map": "./target[classCode=\"indirectAuthority].source[classCode=SDLOC]" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)" }, { "identity": "w5", "map": "where" } ] }, { "path": "Practitioner.practitionerRole.healthcareService", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.healthcareService", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "mapping": [ { "identity": "rim", "map": "./target[classCode=\"indirectAuthority].id?" } ] }, { "path": "Practitioner.practitionerRole", "name": "AdministrativeAffiliation", "short": "Roles/organizations the practitioner is associated with", "definition": "The list of roles/organizations that the practitioner is associated with.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": ".(Role)" } ] }, { "path": "Practitioner.practitionerRole.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.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.", "comments": "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": "Practitioner.practitionerRole.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.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.", "comments": "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": "Practitioner.practitionerRole.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Practitioner.practitionerRole.managingOrganization", "short": "Organization where the roles are performed", "definition": "The organization where the Practitioner performs the roles associated.", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.managingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-organization" ] } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "scopingOrganization" } ] }, { "path": "Practitioner.practitionerRole.role", "short": "Roles which this practitioner may perform", "definition": "Roles which this practitioner is authorized to perform for the organization.", "comments": "A person may have more than one role. At least one role is required.", "requirements": "Need to know what authority the practitioner has - what can they do?", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.role", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "example", "description": "The role a person plays representing an organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, "mapping": [ { "identity": "v2", "map": "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17" }, { "identity": "rim", "map": "./code" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" } ] }, { "path": "Practitioner.practitionerRole.specialty", "short": "Specific specialty of the practitioner", "definition": "Specific specialty of the practitioner.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.specialty", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "example", "description": "Specific specialty associated with the agency", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-specialty" } }, "mapping": [ { "identity": "v2", "map": "PRA-5" }, { "identity": "rim", "map": "indirectAuthority/QualifiedEntity[code < Speciality]/code" }, { "identity": "servd", "map": "./Specialty" } ] }, { "path": "Practitioner.practitionerRole.specialty.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "CodeableConcept.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.specialty.extension", "name": "Practitioner.practitionerRole.specialty.primaryInd", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "CodeableConcept.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd" ] } ], "mapping": [ { "identity": "qidam", "map": "Not in QIDAM, but recognized as important. The primary specialty could drive the order sets or order preferences that are provided as default in an order entry system. Also, a population health management system may want to manage patients with heart failure who are managed by a provider whose primary specialty is cardiology." } ] }, { "path": "Practitioner.practitionerRole.specialty.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" } ] }, { "path": "Practitioner.practitionerRole.specialty.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comments": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }, { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" } ] }, { "path": "Practitioner.practitionerRole.period", "short": "The period during which the practitioner is authorized to perform in these role(s)", "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-8/9 / PRA-5.4" }, { "identity": "rim", "map": "./effectiveTime" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "Practitioner.practitionerRole.location", "short": "The location(s) at which this practitioner provides care", "definition": "The location(s) at which this practitioner provides care.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.location", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-location" ] } ], "mapping": [ { "identity": "rim", "map": "./target[classCode=\"indirectAuthority].source[classCode=SDLOC]" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)" }, { "identity": "w5", "map": "where" } ] }, { "path": "Practitioner.practitionerRole.healthcareService", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.healthcareService", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "mapping": [ { "identity": "rim", "map": "./target[classCode=\"indirectAuthority].id?" } ] }, { "path": "Practitioner.practitionerRole", "name": "PracticeAffiliation", "short": "Roles/organizations the practitioner is associated with", "definition": "The list of roles/organizations that the practitioner is associated with.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": ".(Role)" } ] }, { "path": "Practitioner.practitionerRole.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Practitioner.practitionerRole.extension", "name": "PracticeAffiliationType", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType" ] } ], "binding": { "strength": "example", "description": "A set of codes that describe the kinds of affiliations a provider may have pertaining to the practice of medicine", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-practiceAffiliationType" } } }, { "path": "Practitioner.practitionerRole.extension", "name": "PractitionerPrivilege", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege" ] } ], "binding": { "strength": "preferred", "description": "A set of codes that describe the level at which a provider is authorized to practice medicine at a given isntitution", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-privilege" } } }, { "path": "Practitioner.practitionerRole.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.", "comments": "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": "Practitioner.practitionerRole.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Practitioner.practitionerRole.managingOrganization", "short": "Organization where the roles are performed", "definition": "The organization where the Practitioner performs the roles associated.", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.managingOrganization", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-organization" ] } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "scopingOrganization" } ] }, { "path": "Practitioner.practitionerRole.role", "short": "Roles which this practitioner may perform", "definition": "Roles which this practitioner is authorized to perform for the organization.", "comments": "A person may have more than one role. At least one role is required.", "requirements": "Need to know what authority the practitioner has - what can they do?", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.role", "min": 0, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "example", "description": "The role a person plays representing an organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, "mapping": [ { "identity": "v2", "map": "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17" }, { "identity": "rim", "map": "./code" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" } ] }, { "path": "Practitioner.practitionerRole.specialty", "short": "Specific specialty of the practitioner", "definition": "Specific specialty of the practitioner.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.specialty", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "example", "description": "Specific specialty associated with the agency", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-specialty" } }, "mapping": [ { "identity": "v2", "map": "PRA-5" }, { "identity": "rim", "map": "indirectAuthority/QualifiedEntity[code < Speciality]/code" }, { "identity": "servd", "map": "./Specialty" } ] }, { "path": "Practitioner.practitionerRole.specialty.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "CodeableConcept.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.practitionerRole.specialty.extension", "name": "Practitioner.practitionerRole.specialty.primaryInd", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "CodeableConcept.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/practitioner-primaryInd" ] } ], "mapping": [ { "identity": "qidam", "map": "Not in QIDAM, but recognized as important. The primary specialty could drive the order sets or order preferences that are provided as default in an order entry system. Also, a population health management system may want to manage patients with heart failure who are managed by a provider whose primary specialty is cardiology." } ] }, { "path": "Practitioner.practitionerRole.specialty.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" } ] }, { "path": "Practitioner.practitionerRole.specialty.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comments": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }, { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" } ] }, { "path": "Practitioner.practitionerRole.period", "short": "The period during which the practitioner is authorized to perform in these role(s)", "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "min": 0, "max": "1", "base": { "path": "Practitioner.practitionerRole.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-8/9 / PRA-5.4" }, { "identity": "rim", "map": "./effectiveTime" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" }, { "identity": "w5", "map": "when.done" } ] }, { "path": "Practitioner.practitionerRole.location", "short": "The location(s) at which this practitioner provides care", "definition": "The location(s) at which this practitioner provides care.", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.location", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-location" ] } ], "mapping": [ { "identity": "rim", "map": "./target[classCode=\"indirectAuthority].source[classCode=SDLOC]" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)" }, { "identity": "w5", "map": "where" } ] }, { "path": "Practitioner.practitionerRole.healthcareService", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "min": 0, "max": "*", "base": { "path": "Practitioner.practitionerRole.healthcareService", "min": 0, "max": "*" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/HealthcareService" ] } ], "mapping": [ { "identity": "rim", "map": "./target[classCode=\"indirectAuthority].id?" } ] }, { "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" } ], "mapping": [ { "identity": "v2", "map": "CER?" }, { "identity": "rim", "map": "./indirectAuthority/QualifiedEntity[code < qualifiedEntity]" }, { "identity": "servd", "map": "./Qualifications" } ] }, { "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).", "min": 0, "max": "1", "base": { "path": "Practitioner.qualification.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.qualification.extension", "name": "CredentialEligibiltyIndicator", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Practitioner.qualification.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd" ] } ], "binding": { "strength": "preferred", "description": "The set of values to indicate affirmative or negative", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0136" } } }, { "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.", "comments": "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": "Practitioner.qualification.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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": "./id" } ] }, { "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": { "strength": "example", "description": "Specific qualification the practitioner has to provide a service", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/anzsco-occupations" } }, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "servd", "map": "./Qualifications.Value" } ] }, { "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": "./effectiveTime" }, { "identity": "servd", "map": "./Qualifications.StartDate and ./Qualifications.EndDate" } ] }, { "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", "profile": [ "http://hl7.org/fhir/StructureDefinition/qicore-organization" ] } ], "mapping": [ { "identity": "rim", "map": "./scoper" } ] }, { "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.", "comments": "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": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" }, "mapping": [ { "identity": "v2", "map": "PID-15, NK1-20, LAN-2" }, { "identity": "rim", "map": "./languageCode" }, { "identity": "servd", "map": "./Languages.LanguageSpokenCode" } ] }, { "path": "Practitioner.communication.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "base": { "path": "CodeableConcept.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.communication.extension", "name": "CommunicationMode", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "CodeableConcept.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode" ] } ], "binding": { "strength": "preferred", "description": "A set of codes that describe the method by which an individual communicates", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-communicationMode" } } }, { "path": "Practitioner.communication.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" }, { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" } ] }, { "path": "Practitioner.communication.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comments": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "isSummary": true, "mapping": [ { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" }, { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" } ] } ] }, "differential": { "element": [ { "path": "Practitioner", "name": "hspc-provpract", "min": 0, "max": "*", "type": [ { "code": "Practitioner" } ] }, { "path": "Practitioner.classification", "binding": { "strength": "preferred", "description": "A more specific service or occupation within the health care provider type of the practitioner at a specific organization unit. (Example: Counselor.)", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-providerClassification" } } }, { "path": "Practitioner.telecom" }, { "path": "Practitioner.telecom.extension", "name": "PreferenceIndicator", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/iso21090-preferred" ] } ] }, { "path": "Practitioner.address" }, { "path": "Practitioner.address.extension", "name": "PrimaryIndicator", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionsprimaryIndicator" ] } ], "binding": { "strength": "preferred", "description": "The set of values to indicate affirmative or negative", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0136" } } }, { "path": "Practitioner.practitionerRole", "slicing": { "discriminator": [ "Practitioner.practitionerRole.managingOrganization", "Practitioner.practitionerRole.role" ], "ordered": false, "rules": "open" } }, { "path": "Practitioner.practitionerRole", "name": "PractitionerRole" }, { "path": "Practitioner.practitionerRole.role", "binding": { "strength": "preferred", "description": "A set of codes that describe the general practice category for a provider.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-providerPractitionerType" } } }, { "path": "Practitioner.practitionerRole.specialty", "binding": { "strength": "preferred", "description": "A set of codes that describe the specific specialty in which a provider practices.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-providerPractitionerSpecialty" } } }, { "path": "Practitioner.practitionerRole", "name": "AdministrativeAffiliation" }, { "path": "Practitioner.practitionerRole", "name": "PracticeAffiliation" }, { "path": "Practitioner.practitionerRole.extension", "name": "PracticeAffiliationType", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionspracticeAffiliationType" ] } ], "binding": { "strength": "example", "description": "A set of codes that describe the kinds of affiliations a provider may have pertaining to the practice of medicine", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-practiceAffiliationType" } } }, { "path": "Practitioner.practitionerRole.extension", "name": "PractitionerPrivilege", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionspractitionerPrivilege" ] } ], "binding": { "strength": "preferred", "description": "A set of codes that describe the level at which a provider is authorized to practice medicine at a given isntitution", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-practitioner-privilege" } } }, { "path": "Practitioner.qualification" }, { "path": "Practitioner.qualification.extension", "name": "CredentialEligibiltyIndicator", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionscredentialEligibilityInd" ] } ], "binding": { "strength": "preferred", "description": "The set of values to indicate affirmative or negative", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/v2-0136" } } }, { "path": "Practitioner.communication" }, { "path": "Practitioner.communication.extension", "name": "CommunicationMode", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/hspc-extensionscommunicationMode" ] } ], "binding": { "strength": "preferred", "description": "A set of codes that describe the method by which an individual communicates", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/hspc-communicationMode" } } } ] } }