This page is part of the FHIR Specification (v0.4.0: DSTU 2 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
Todo
Definitions for the pract-uslab-uslabphpract Profile.
Practitioner(USLabPHPract) | |
Definition | This is the provider who either ordered a lab test or to whom the results have been sent. |
Control | 1..1 |
Requirements | Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc. |
Alternate Names | Provider, Orderer, Submitting Physician |
Comments | Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?. |
Invariants | Defined on this element inv-1: Shall have Organization.name and/or Organization.identifier. (xpath: exists(f:name) or exists(f:identifier)) |
Practitioner.id | |
Definition | The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Requirements | |
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. |
Practitioner.meta | |
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. |
Control | 0..1 |
Type | Meta |
Requirements | |
Comments | |
Practitioner.implicitRules | |
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. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Requirements | |
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. |
Practitioner.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Requirements | |
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). |
Practitioner.text | |
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. |
Control | 1..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Must Support | true |
Requirements | |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Practitioner.text.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.text.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.text.status | |
Definition | The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data. |
Control | 1..1 |
Binding | The status of a resource narrative The codes SHALL be taken from NarrativeStatus |
Type | code |
Must Support | true |
Requirements | |
Comments | |
Fixed Value | generated |
Practitioner.text.div | |
Definition | The actual narrative content, a stripped down version of XHTML. |
Control | 1..1 |
Type | xhtml |
Requirements | |
Comments | The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects. |
Invariants | Defined on this element txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (xpath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])) txt-2: The narrative SHALL have some non-whitespace content (xpath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]) txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (xpath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])) |
Practitioner.contained | |
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. |
Control | 0..* |
Type | Resource |
Requirements | |
Alternate Names | inline resources, anonymous resources, contained resources |
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. |
Practitioner.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.modifierExtension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.identifier | |
Definition | An identifier that applies to this person in this role. |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Requirements | Often, specific identities are assigned for the agent. |
Comments | |
Pattern Value | <valueIdentifier xmlns="http://hl7.org/fhir"> <use value="official"/> <label value="NPI"/> <assigner> <reference value="https://nppes.cms.hhs.gov/NPPES/"/> <display value="The Centers for Medicare and Medicaid Services (CMS) National Plan and Provider Enumeration System (NPPES"/> </assigner> </valueIdentifier> |
Practitioner.identifier.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.identifier.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.identifier.use | |
Definition | The purpose of this identifier. |
Control | 0..1 |
Binding | Identifies the purpose for this identifier, if known The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Practitioner.identifier.label | |
Definition | A text string for the identifier that can be displayed to a human so they can recognize the identifier. |
Control | 0..1 |
Type | string |
Requirements | Allows humans to make use of identifiers when the identifier system is not known. |
Comments | |
Practitioner.identifier.system | |
Definition | Establishes the namespace in which set of possible id values is unique. |
Control | 0..1 |
Type | uri |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Example | http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri |
Practitioner.identifier.value | |
Definition | NPI Provider Number. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 123456 |
Practitioner.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Requirements | |
Comments | |
Practitioner.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | The reference may be just a text description of the assigner. |
Practitioner.name | |
Definition | A name associated with the person. |
Control | 0..1 |
Type | HumanName |
Must Support | true |
Requirements | Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Comments | |
Practitioner.name.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.name.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.name.use | |
Definition | Identifies the purpose for this name. |
Control | 0..1 |
Binding | The use of a human name The codes SHALL be taken from NameUse |
Type | code |
Is Modifier | true |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Practitioner.name.text | |
Definition | A full text representation of the name. |
Control | 0..1 |
Type | string |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and structured parts. |
Practitioner.name.family | |
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | |
Alternate Names | surname |
Comments | For family name, hyphenated names such as "Smith-Jones" are a single name, but names with spaces such as "Smith Jones" are broken into multiple parts. |
Practitioner.name.given | |
Definition | Given name. |
Control | 0..2 |
Type | string |
Must Support | true |
Requirements | |
Alternate Names | first name, middle name |
Comments | If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. |
Practitioner.name.prefix | |
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | |
Comments | |
Practitioner.name.suffix | |
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | |
Comments | |
Practitioner.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Control | 0..1 |
Type | Period |
Requirements | Allows names to be placed in historical context. |
Comments | |
Practitioner.telecom | |
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. |
Control | 0..2 |
Type | ContactPoint |
Must Support | true |
Requirements | Need to know how to reach a practitioner. |
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. |
Practitioner.telecom.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.telecom.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Control | 1..1 This element is affected by the following invariants: cpt-2 |
Binding | Telecommunications form for contact point The codes SHALL be taken from ContactPointSystem |
Type | code |
Must Support | true |
Requirements | |
Comments | |
Practitioner.telecom.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional out of band data such as extensions, or notes about use of the contact are sometimes included in the value. |
Practitioner.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Control | 0..1 |
Binding | Use of contact point The codes SHALL be taken from ContactPointUse |
Type | code |
Is Modifier | true |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
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. |
Practitioner.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Control | 0..1 |
Type | Period |
Requirements | |
Comments | |
Practitioner.address | |
Definition | The postal address where the practitioner can be found or visited or to which mail can be delivered. |
Control | 0..1 |
Type | Address |
Must Support | true |
Requirements | Need to keep track where the practitioner can found during work or for directing mail. |
Comments | |
Practitioner.address.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.address.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Practitioner.address.extension (http://hl7.org/fhir/ExtensionDefinition/us-core-county) | |
Definition | Name of county. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | |
Practitioner.address.extension.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.address.extension.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Practitioner.address.extension.extension(USLabCountycodes) | |
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. |
Control | 1..1 |
Binding | FIPS codes for US counties and county equivalent entities The codes SHALL be taken from US counties and county equivalent entities codes |
Type | Coding |
Must Support | true |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.address.extension.extension.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.address.extension.extension.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.address.extension.extension.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Practitioner.address.extension.extension.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Practitioner.address.extension.extension.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Practitioner.address.extension.extension.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Control | 0..1 |
Type | string |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Practitioner.address.extension.extension.primary | |
Definition | Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact code was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. |
Practitioner.address.extension.extension.valueSet | |
Definition | The set of possible coded values this coding was chosen from or constrained by. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet)) |
Requirements | The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare. |
Comments | |
Practitioner.address.extension.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
Requirements | |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #. |
Practitioner.address.extension.value[x] | |
Definition | Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
Control | 0..1 |
Type | * |
Requirements | |
Comments | |
Practitioner.address.use | |
Definition | The purpose of this address. |
Control | 0..1 |
Binding | The use of an address The codes SHALL be taken from AddressUse |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | Allows an appropriate address to be chosen from a list of many. |
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. |
Example | home |
Practitioner.address.text | |
Definition | A full text representation of the address. |
Control | 0..1 |
Type | string |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. |
Example | 137 Nowhere Street, Erewhon 9132 |
Practitioner.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Control | 0..2 |
Type | string |
Must Support | true |
Requirements | home | work | temp | old - purpose of this address. |
Comments | |
Example | 137 Nowhere Street |
Practitioner.address.city | |
Definition | The name of the city, town, village or other community or delivery center. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | |
Alternate Names | Muncipality |
Comments | |
Example | Erewhon |
Practitioner.address.state | |
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). |
Control | 0..1 |
Binding | Two letter USPS alphabetic codes. The codes SHALL be taken from USPS Two Letter Alphabetic Codes; other codes may be used where these codes are not suitable |
Type | string |
Must Support | true |
Requirements | |
Alternate Names | Province, Territory |
Comments | |
Practitioner.address.postalCode | |
Definition | US Zip Codes. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | |
Alternate Names | Zip |
Comments | |
Example | 9132 |
Invariants | Defined on this element inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes. (xpath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )) |
Practitioner.address.country | |
Definition | ISO 3166 3 letter Country Code. |
Control | 0..1 |
Binding | ISO 3 letter codes The codes SHALL be taken from USLabCountry; other codes may be used where these codes are not suitable |
Type | string |
Must Support | true |
Requirements | |
Comments | ISO 3166 3 letter codes can be used in place of a full country name. |
Practitioner.address.period | |
Definition | Time period when address was/is in use. |
Control | 0..1 |
Type | Period |
Requirements | Allows addresses to be placed in historical context. |
Comments | |
Example | <valuePeriod xmlns="http://hl7.org/fhir"><br/> <start value="2010-03-23"/><br/> <end value="2010-07-01"/><br/></valuePeriod><br/> |
Practitioner.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Control | 0..1 |
Binding | The gender of a person used for administrative purposes The codes SHALL be taken from AdministrativeGender |
Type | code |
Requirements | Needed to address the person correctly. |
Comments | |
Practitioner.birthDate | |
Definition | The date of birth for the practitioner. |
Control | 0..1 |
Type | date |
Requirements | Needed for identification. |
Comments | |
Practitioner.photo | |
Definition | Image of the person. |
Control | 0..* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. |
Comments | |
Practitioner.practitionerRole | |
Definition | The list of Roles/Organizations that the Practitioner is associated with. |
Control | 1..1 |
Must Support | true |
Requirements | |
Comments | |
Practitioner.practitionerRole.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.practitionerRole.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.practitionerRole.modifierExtension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
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. |
Practitioner.practitionerRole.managingOrganization | |
Definition | A reference to the organization that placed the lab order. It could be a doctor's office, hospital or clinic. |
Control | 1..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/org-uslab-uslaborderfacility)) |
Must Support | true |
Requirements | |
Comments | |
Practitioner.practitionerRole.role | |
Definition | Roles which this practitioner is authorized to perform for the organization. |
Control | 0..1 |
Binding | The role a person plays representing an organization For example codes, see PractitionerRole |
Type | CodeableConcept |
Requirements | Need to know what authority the practitioner has - what can they do?. |
Comments | A person may have more than one role. At least one role is required. |
Practitioner.practitionerRole.specialty | |
Definition | Specific specialty of the practitioner. |
Control | 0..* |
Binding | Specific specialty associated with the agency For example codes, see PractitionerSpecialty |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.practitionerRole.period | |
Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. |
Control | 0..1 |
Type | Period |
Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. |
Comments | |
Practitioner.practitionerRole.location | |
Definition | The location(s) at which this practitioner provides care. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Location)) |
Requirements | |
Comments | |
Practitioner.practitionerRole.healthcareService | |
Definition | The list of healthcare services that this worker offers at this location of this organization. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/HealthcareService)) |
Requirements | |
Comments | |
Practitioner.qualification | |
Definition | Qualifications obtained by training and certification. |
Control | 0..* |
Requirements | |
Comments | |
Practitioner.qualification.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Practitioner.qualification.extension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
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. |
Practitioner.qualification.modifierExtension | |
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. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
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. |
Practitioner.qualification.identifier | |
Definition | An identifier that applies to this person's qualification in this role. |
Control | 0..* |
Type | Identifier |
Requirements | Often, specific identities are assigned for the qualification. |
Comments | |
Practitioner.qualification.code | |
Definition | Coded representation of the qualification. |
Control | 1..1 |
Binding | Specific qualification the practitioner has to provide a service For example codes, see ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 |
Type | CodeableConcept |
Requirements | |
Comments | |
Practitioner.qualification.period | |
Definition | Period during which the qualification is valid. |
Control | 0..1 |
Type | Period |
Requirements | Qualifications are often for a limited period of time, and can be revoked. |
Comments | |
Practitioner.qualification.issuer | |
Definition | Organization that regulates and issues the qualification. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | |
Practitioner.communication | |
Definition | A language the practitioner is able to use in patient communication. |
Control | 0..* |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | CodeableConcept |
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. |
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. |