DSTU2
This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
(v1.0.2:
DSTU
1).
2).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
Profile
StructureDefinition
for
practitioner
{
"resourceType": "Profile",
"resourceType": "StructureDefinition",
"id": "Practitioner",
"meta": {
"lastUpdated": "2015-10-24T07:41:03.495+11:00"
},
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A person who is directly or indirectly involved in the provisioning of healthcare.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner\"><b>Practitioner</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"An identifier that applies to this person in this role.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">A identifier for the person as this agent<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"A name associated with the person.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.name\"><b>name</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#HumanName\">HumanName</a></span> <span style=\"color: navy\">A name associated with the person<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></name>\r\n <<a title=\"A contact detail for the practitioner, e.g. a telephone number or an email address.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.telecom\"><b>telecom</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Contact\">Contact</a></span> <span style=\"color: navy\">A contact detail for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></telecom>\r\n <<a title=\"The postal address where the practitioner can be found or visited or to which mail can be delivered.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.address\"><b>address</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Address\">Address</a></span> <span style=\"color: navy\">Where practitioner can be found/visited<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></address>\r\n <<a title=\"Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.gender\"><b>gender</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-administrative-gender.html\">Gender for administrative purposes<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></gender>\r\n <<a title=\"The date and time of birth for the practitioner.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.birthDate\"><b>birthDate</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">The date and time of birth for the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Image of the person.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.photo\"><b>photo</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Attachment\">Attachment</a></span> <span style=\"color: navy\">Image of the person</span><span style=\"color: Gray\"> --></span></photo>\r\n <<a title=\"The organization that the practitioner represents.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.organization\"><b>organization</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">The represented organization<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></organization>\r\n <<a title=\"Roles which this practitioner is authorized to perform for the organization.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.role\"><b>role</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-role.html\">Roles which this practitioner may perform<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></role>\r\n <<a title=\"Specific specialty of the practitioner.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.specialty\"><b>specialty</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-practitioner-specialty.html\">Specific specialty of the practitioner<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></a></span><span style=\"color: Gray\"> --></span></specialty>\r\n <<a title=\"The period during which the person is authorized to act as a practitioner in these role(s) for the organization.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">\r\n The period during which the practitioner is authorized to perform in these role(s)<span title=\"This element is included in a summary view (See Search/Query)\" style=\"color: Navy\"> §</span></span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"The location(s) at which this practitioner provides care.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.location\"><b>location</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n The location(s) at which this practitioner provides care</span><span style=\"color: Gray\"> --></span></location>\r\n <<a title=\"Qualifications obtained by training and certification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification\"><b>qualification</b></a>> <span style=\"color: Gray\"><!-- <span style=\"color: brown\"><b>0..*</b></span> Qualifications obtained by training and certification --></span>\r\n <<a title=\"Coded representation of the qualification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-anzsco-occupations.html\">Coded representation of the qualification</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"Period during which the qualification is valid.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.period\"><b>period</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Period\">Period</a></span> <span style=\"color: navy\">Period during which the qualification is valid</span><span style=\"color: Gray\"> --></span></period>\r\n <<a title=\"Organization that regulates and issues the qualification.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.qualification.issuer\"><b>issuer</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"organization.html#Organization\">Organization</a>)</span> <span style=\"color: navy\">\r\n Organization that regulates and issues the qualification</span><span style=\"color: Gray\"> --></span></issuer>\r\n </qualification>\r\n <<a title=\"A language the practitioner is able to use in patient communication.\" class=\"dict\" href=\"practitioner-definitions.html#Practitioner.communication\"><b>communication</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"http://tools.ietf.org/html/bcp47.html\">A language the practitioner is able to use in patient communication</a></span><span style=\"color: Gray\"> --></span></communication>\r\n</Practitioner>\r\n</pre></div>"
"div": "<div>!-- Snipped for Brevity --></div>"
},
"name": "practitioner",
"publisher": "FHIR Project",
"description": "Basic Profile. A person who is directly or indirectly involved in the provisioning of healthcare.",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/Practitioner",
"name": "Practitioner",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage Practitioner covers all individuals who are engaged in the healthcare process and healthcare-related services as part of their formal responsibilities and this Resource is used for attribution of activities and responsibilities to these individuals. Practitioners include (but are not limited to): \r\n\r\n* physicians, dentists, pharmacists\r\n* physician assistants, nurses, scribes\r\n* midwives, dietitians, therapists, optometrists, paramedics\r\n* medical technicians, laboratory scientists, prosthetic technicians, radiographers\r\n* social workers, professional home carers, official volunteers\r\n* receptionists handling patient registration\r\n* IT personnel merging or unmerging patient records",
"mapping": [
"publisher": "Health Level Seven International (Patient Administration)",
"contact": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/pafm/index.cfm"
}
]
}
],
"date": "2015-10-24T07:41:03+11:00",
"description": "Base StructureDefinition for Practitioner Resource",
"requirements": "Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.",
"fhirVersion": "1.0.2",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
},
{
"identity": "servd",
"uri": "http://www.omg.org/spec/ServD/1.0/",
"name": "ServD"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
}
],
"structure": [
{
"type": "Practitioner",
"publish": true,
"element": [
{
"path": "Practitioner",
"definition": {
"short": "A person with a formal responsibility in the provisioning of healthcare or related services",
"formal": "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": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Role"
},
{
"identity": "v2",
"map": "PRD (as one example)"
},
{
"identity": "servd",
"map": "Provider"
}
]
"kind": "resource",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"snapshot": {
"element": [
{
"path": "Practitioner",
"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": "*",
"type": [
{
"code": "DomainResource"
}
},
{
"path": "Practitioner.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
],
"mapping": [
{
"identity": "v2",
"map": "PRD (as one example)"
},
{
"identity": "rim",
"map": "Role"
},
{
"identity": "servd",
"map": "Provider"
},
{
"identity": "w5",
"map": "administrative.individual"
}
},
{
"path": "Practitioner.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
]
},
{
"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",
"type": [
{
"code": "id"
}
},
{
"path": "Practitioner.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "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.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
],
"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",
"type": [
{
"code": "Meta"
}
},
{
"path": "Practitioner.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
],
"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",
"type": [
{
"code": "uri"
}
},
{
"path": "Practitioner.identifier",
"definition": {
"short": "A identifier for the person as this agent",
"formal": "An identifier that applies to this person in this role.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./id"
},
{
"identity": "v2",
"map": "PRD-7 (or XCN.1 Person Identifier)"
},
{
"identity": "servd",
"map": "./Identifiers"
}
]
],
"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",
"type": [
{
"code": "code"
}
},
{
"path": "Practitioner.name",
"definition": {
"short": "A name associated with the person",
"formal": "A name associated with the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./name"
},
{
"identity": "v2",
"map": "XCN Components"
},
{
"identity": "servd",
"map": "./PreferredName (GivenNames, FamilyName, TitleCode)"
}
]
],
"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",
"type": [
{
"code": "Narrative"
}
},
{
"path": "Practitioner.telecom",
"definition": {
"short": "A contact detail for the practitioner",
"formal": "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. \rMay need to have options for contacting the person urgently, and also to help with identification.",
"min": 0,
"max": "*",
"type": [
{
"code": "Contact"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./telecom"
},
{
"identity": "v2",
"map": "PRT-15, STF-10, ROL-12"
},
{
"identity": "servd",
"map": "./ContactPoints"
}
]
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
},
{
"path": "Practitioner.address",
"definition": {
"short": "Where practitioner can be found/visited",
"formal": "The postal address where the practitioner can be found or visited or to which mail can be delivered.",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./addr"
},
{
"identity": "v2",
"map": "ORC-24, STF-11, ROL-11, PRT-14"
},
{
"identity": "servd",
"map": "./Addresses"
}
]
]
},
{
"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": "*",
"type": [
{
"code": "Resource"
}
},
{
"path": "Practitioner.gender",
"definition": {
"short": "Gender for administrative purposes",
"formal": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "AdministrativeGender",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"identity": "rim",
"map": "./administrativeGender"
},
{
"identity": "v2",
"map": "STF-5"
},
{
"identity": "servd",
"map": "./GenderCode"
}
]
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
},
{
"path": "Practitioner.birthDate",
"definition": {
"short": "The date and time of birth for the practitioner",
"formal": "The date and time of birth for the practitioner.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./birthTime"
},
{
"identity": "v2",
"map": "STF-6"
},
{
"identity": "servd",
"map": "(not represented in ServD)"
}
]
]
},
{
"path": "Practitioner.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"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": "*",
"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",
"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",
"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": "*",
"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.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": "*",
"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.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",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"path": "Practitioner.photo",
"definition": {
"short": "Image of the person",
"formal": "Image of the person.",
"min": 0,
"max": "*",
"type": [
{
"code": "Attachment"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity": "servd",
"map": "./ImageURI (only supports the URI reference)"
}
"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",
"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": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity": "servd",
"map": "./ImageURI (only supports the URI reference)"
}
]
},
{
"path": "Practitioner.practitionerRole",
"short": "Roles/organizations the practitioner is associated with",
"definition": "The list of roles/organizations that the practitioner is associated with.",
"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",
"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": "*",
"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": "*",
"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",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"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",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The role a person plays representing an organization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/practitioner-role"
}
},
{
"path": "Practitioner.organization",
"definition": {
"short": "The represented organization",
"formal": "The organization that the practitioner represents.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./scoper"
},
{
"identity": "v2",
"map": "PRD-10 (-> 14) / PRA-9-Institution / PRT-8-Participation Organization for person participation"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
]
"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": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Specific specialty associated with the agency",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/practitioner-specialty"
}
},
{
"path": "Practitioner.role",
"definition": {
"short": "Roles which this practitioner may perform",
"formal": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PractitionerRole",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/practitioner-role"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "v2",
"map": "PRD-1 / STF-18-job title / PRA-3-practitioner category / PRT-4-Participation / ROL-3-role-ROL / ORC-12-ordering provider / OBR-16-ordering provider / PV1-7-attending doctor / PV1-8-referring doctor / PV1-9-consulting doctor / PV1-17-admitting doctor"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
"mapping": [
{
"identity": "v2",
"map": "PRA-5"
},
{
"identity": "rim",
"map": "indirectAuthority/QualifiedEntity[code < Speciality]/code"
},
{
"identity": "servd",
"map": "./Specialty"
}
]
},
{
"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",
"type": [
{
"code": "Period"
}
],
"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": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
},
{
"path": "Practitioner.specialty",
"definition": {
"short": "Specific specialty of the practitioner",
"formal": "Specific specialty of the practitioner.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "PractitionerSpecialty",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/practitioner-specialty"
}
},
"mapping": [
{
"identity": "rim",
"map": "indirectAuthority/QualifiedEntity[code < Speciality]/code"
},
{
"identity": "v2",
"map": "PRA-5-specialty"
},
{
"identity": "servd",
"map": "./Specialty"
}
],
"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": "*",
"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": "*",
"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",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Practitioner.qualification.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": "*",
"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": "*",
"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",
"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"
}
},
{
"path": "Practitioner.period",
"definition": {
"short": "The period during which the practitioner is authorized to perform in these role(s)",
"formal": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "v2",
"map": "PRD-8/9 / PRA-5.4-date of certification"
},
{
"identity": "servd",
"map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)"
}
"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",
"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",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/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": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
{
"path": "Practitioner.location",
"definition": {
"short": "The location(s) at which this practitioner provides care",
"formal": "The location(s) at which this practitioner provides care.",
"min": 0,
"max": "*",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"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/>\nHowever these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)"
}
]
"mapping": [
{
"identity": "v2",
"map": "PID-15, NK1-20, LAN-2"
},
{
"identity": "rim",
"map": "./languageCode"
},
{
"identity": "servd",
"map": "./Languages.LanguageSpokenCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Practitioner",
"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": "*",
"type": [
{
"code": "DomainResource"
}
],
"mapping": [
{
"identity": "v2",
"map": "PRD (as one example)"
},
{
"identity": "rim",
"map": "Role"
},
{
"identity": "servd",
"map": "Provider"
},
{
"identity": "w5",
"map": "administrative.individual"
}
]
},
{
"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": "*",
"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",
"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",
"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": "*",
"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.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": "*",
"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.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",
"type": [
{
"code": "code"
}
],
"isSummary": true,
"binding": {
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"path": "Practitioner.qualification",
"definition": {
"short": "Qualifications obtained by training and certification",
"formal": "Qualifications obtained by training and certification.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./indirectAuthority/QualifiedEntity[code < qualifiedEntity]"
},
{
"identity": "v2",
"map": "CER?"
},
{
"identity": "servd",
"map": "./Qualifications"
}
"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",
"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": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "rim",
"map": "./subjectOf/ObservationEvent[code=\"photo\"]/value"
},
{
"identity": "servd",
"map": "./ImageURI (only supports the URI reference)"
}
]
},
{
"path": "Practitioner.practitionerRole",
"short": "Roles/organizations the practitioner is associated with",
"definition": "The list of roles/organizations that the practitioner is associated with.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "rim",
"map": ".(Role)"
}
]
},
{
"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",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
},
{
"path": "Practitioner.qualification.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
],
"mapping": [
{
"identity": "rim",
"map": "scopingOrganization"
}
},
{
"path": "Practitioner.qualification.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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 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 simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
]
},
{
"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",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The role a person plays representing an organization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/practitioner-role"
}
},
{
"path": "Practitioner.qualification.code",
"definition": {
"short": "Coded representation of the qualification",
"formal": "Coded representation of the qualification.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Qualification",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/anzsco-occupations"
}
},
"mapping": [
{
"identity": "rim",
"map": "./code"
},
{
"identity": "servd",
"map": "./Qualifications.Value"
}
]
"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": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Specific specialty associated with the agency",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/practitioner-specialty"
}
},
{
"path": "Practitioner.qualification.period",
"definition": {
"short": "Period during which the qualification is valid",
"formal": "Period during which the qualification is valid.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./effectiveTime"
},
{
"identity": "servd",
"map": "./Qualifications.StartDate and ./Qualifications.EndDate"
}
"mapping": [
{
"identity": "v2",
"map": "PRA-5"
},
{
"identity": "rim",
"map": "indirectAuthority/QualifiedEntity[code < Speciality]/code"
},
{
"identity": "servd",
"map": "./Specialty"
}
]
},
{
"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",
"type": [
{
"code": "Period"
}
],
"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": "*",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Location"
]
}
},
{
"path": "Practitioner.qualification.issuer",
"definition": {
"short": "Organization that regulates and issues the qualification",
"formal": "Organization that regulates and issues the qualification.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Organization"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "./scoper"
}
],
"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": "*",
"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": "*",
"type": [
{
"code": "BackboneElement"
}
],
"mapping": [
{
"identity": "v2",
"map": "CER?"
},
{
"identity": "rim",
"map": "./indirectAuthority/QualifiedEntity[code < qualifiedEntity]"
},
{
"identity": "servd",
"map": "./Qualifications"
}
]
},
{
"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": "*",
"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",
"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"
}
},
{
"path": "Practitioner.communication",
"definition": {
"short": "A language the practitioner is able to use in patient communication",
"formal": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "Language",
"isExtensible": false,
"conformance": "required",
"referenceUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "rim",
"map": "./languageCode"
},
{
"identity": "v2",
"map": "PID-15, NK1-20, LAN-2"
},
{
"identity": "servd",
"map": "./Languages.LanguageSpokenCode"
}
"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",
"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",
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "address",
"type": "string",
"documentation": "An address in any kind of address/part",
"xpath": "f:Practitioner/f:address"
},
{
"name": "family",
"type": "string",
"documentation": "A portion of the family name",
"xpath": "f:Practitioner/f:name"
},
{
"name": "gender",
"type": "token",
"documentation": "Gender of the practitioner",
"xpath": "f:Practitioner/f:gender"
},
{
"name": "given",
"type": "string",
"documentation": "A portion of the given name",
"xpath": "f:Practitioner/f:name"
},
{
"name": "identifier",
"type": "token",
"documentation": "A practitioner's Identifier",
"xpath": "f:Practitioner/f:identifier"
},
{
"name": "name",
"type": "string",
"documentation": "A portion of either family or given name",
"xpath": "f:Practitioner/f:name"
},
{
"name": "organization",
"type": "reference",
"documentation": "The identity of the organization the practitioner represents / acts on behalf of",
"xpath": "f:Practitioner/f:organization"
},
{
"name": "phonetic",
"type": "string",
"documentation": "A portion of either family or given name using some kind of phonetic matching algorithm",
"xpath": "f:Practitioner/f:name"
],
"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": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
{
"name": "telecom",
"type": "string",
"documentation": "The value in any kind of contact",
"xpath": "f:Practitioner/f:telecom"
}
]
}
]
"mapping": [
{
"identity": "v2",
"map": "PID-15, NK1-20, LAN-2"
},
{
"identity": "rim",
"map": "./languageCode"
},
{
"identity": "servd",
"map": "./Languages.LanguageSpokenCode"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
©
©
HL7.org
2011+.
FHIR
DSTU
(v0.0.82.2943)
DSTU2
(v1.0.2-7202)
generated
on
Tue,
Sep
30,
2014
18:10+1000.
Sat,
Oct
24,
2015
07:43+1100.
Links:
What's
a
DSTU?
Search
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1
|
|
Propose
a
change