This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 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
StructureDefinition for USLab Practitioner
{ "resourceType": "StructureDefinition", "id": "pract-uslab-uslabphpract", "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "url": "http://hl7.org/fhir/StructureDefinition/pract-uslab-uslabphpract", "name": "US Laboratory Practitioner Profile", "publisher": "HL7 International - Orders and Observations WG", "contact": [ { "telecom": [ { "system": "url", "value": "http://hl7.org" } ] } ], "description": "USLab Practitioner", "status": "draft", "date": "2014-11-17", "type": "constraint", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/Practitioner", "snapshot": { "element": [ { "path": "Practitioner", "name": "USLabPHPract", "short": "USLab Practitioner", "definition": "This is the provider who either ordered a lab test or to whom the results have been sent.", "comments": "Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?", "requirements": "Need to track doctors, staff, locums etc. for both healthcare practitioners, funders, etc.", "alias": [ "Provider", "Orderer", "Submitting Physician" ], "min": 1, "max": "1", "type": [ { "code": "Practitioner" } ], "constraint": [ { "key": "inv-1", "name": "NameandorID", "severity": "error", "human": "Shall have Organization.name and/or Organization.identifier.", "xpath": "exists(f:name) or exists(f:identifier)" } ], "mapping": [ { "identity": "v2", "map": "PRD (as one example)" }, { "identity": "rim", "map": "Role" }, { "identity": "servd", "map": "Provider" } ] }, { "path": "Practitioner.id", "short": "Logical id of this artefact", "definition": "The logical id of the resource, as used in the url for the resoure. 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.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.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" } ], "isModifier": 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\n\nNot 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" } ], "binding": { "name": "Language", "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" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "Practitioner.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "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": "1", "type": [ { "code": "Identifier" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRD-7 (or XCN.1 Person Identifier)" }, { "identity": "rim", "map": "./id" }, { "identity": "servd", "map": "./Identifiers" } ] }, { "path": "Practitioner.identifier.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.identifier.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.identifier.use", "short": "usual | official | temp | secondary (If known)", "definition": "The purpose of this identifier.", "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.", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "mustSupport": true, "isModifier": true, "binding": { "name": "IdentifierUse", "strength": "required", "description": "Identifies the purpose for this identifier, if known", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/identifier-use" } }, "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "path": "Practitioner.identifier.type", "short": "Description of identifier", "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "comments": "Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 0, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "IdentifierType", "strength": "extensible", "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/identifier-type" } }, "mapping": [ { "identity": "v2", "map": "CX.5" }, { "identity": "rim", "map": "Role.code or implied by context" } ] }, { "path": "Practitioner.identifier.system", "short": "OID for National Provider Identifier (NPI)", "definition": "See https://nppes.cms.hhs.gov/NPPES/.", "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.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "fixedUri": "urn:oid:2.16.840.1.113883.4.6", "exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri", "mustSupport": true, "mapping": [ { "identity": "v2", "map": "CX.4 / EI-2-4" }, { "identity": "rim", "map": "II.root or Role.id.root" }, { "identity": "servd", "map": "./IdentifierType" } ] }, { "path": "Practitioner.identifier.value", "short": "NPI Provider Number", "definition": "NPI Provider Number.", "comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "exampleString": "123456", "mustSupport": true, "mapping": [ { "identity": "v2", "map": "CX.1 / EI.1" }, { "identity": "rim", "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)" }, { "identity": "servd", "map": "./Value" } ] }, { "path": "Practitioner.identifier.period", "short": "Time period when id is/was valid for use", "definition": "Time period during which identifier is/was valid for use.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "v2", "map": "CX.7 + CX.8" }, { "identity": "rim", "map": "Role.effectiveTime or implied by context" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "path": "Practitioner.identifier.assigner", "short": "Organization that issued id (may be just text)", "definition": "Organization that issued/manages the identifier.", "comments": "The reference may be just a text description of the assigner.", "min": 0, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "mapping": [ { "identity": "v2", "map": "CX.4 / (CX.4,CX.9,CX.10)" }, { "identity": "rim", "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper" }, { "identity": "servd", "map": "./IdentifierIssuingAuthority" } ] }, { "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" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XCN Components" }, { "identity": "rim", "map": "./name" }, { "identity": "servd", "map": "./PreferredName (GivenNames, FamilyName, TitleCode)" } ] }, { "path": "Practitioner.name.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.name.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.name.use", "short": "usual | official | temp | nickname | anonymous | old | maiden", "definition": "Identifies the purpose for this name.", "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.", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "binding": { "name": "NameUse", "strength": "required", "description": "The use of a human name", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/name-use" } }, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ] }, { "path": "Practitioner.name.text", "short": "Text representation of the full name", "definition": "A full text representation of the name.", "comments": "Can provide both a text representation and structured parts.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ] }, { "path": "Practitioner.name.family", "short": "Family name (often called 'Surname')", "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "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.", "alias": [ "surname" ], "min": 1, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "XPN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ] }, { "path": "Practitioner.name.given", "short": "Given names (not always 'first'). Includes middle names", "definition": "Given 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.", "alias": [ "first name", "middle name" ], "min": 0, "max": "2", "type": [ { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ] }, { "path": "Practitioner.name.prefix", "short": "Parts that come before the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ] }, { "path": "Practitioner.name.suffix", "short": "Parts that come after the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ] }, { "path": "Practitioner.name.period", "short": "Time period when name was/is in use", "definition": "Indicates the period of time when this name was valid for the named person.", "requirements": "Allows names to be placed in historical context.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "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. \rMay 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": "2", "type": [ { "code": "ContactPoint" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PRT-15, STF-10, ROL-12" }, { "identity": "rim", "map": "./telecom" }, { "identity": "servd", "map": "./ContactPoints" } ] }, { "path": "Practitioner.telecom.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.telecom.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.telecom.system", "short": "phone | fax | email | url", "definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.", "min": 1, "max": "1", "type": [ { "code": "code" } ], "condition": [ "cpt-2" ], "mustSupport": true, "binding": { "name": "ContactPointSystem", "strength": "required", "description": "Telecommunications form for contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/contact-point-system" } }, "mapping": [ { "identity": "v2", "map": "XTN.3" }, { "identity": "rim", "map": "./scheme" }, { "identity": "servd", "map": "./ContactPointType" } ] }, { "path": "Practitioner.telecom.value", "short": "The actual contact point details", "definition": "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).", "comments": "Additional out of band data such as extensions, or notes about use of the contact are sometimes included in the value.", "requirements": "Need to support legacy numbers that are not in a tightly controlled format.", "min": 1, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "XTN.1 (or XTN.12)" }, { "identity": "rim", "map": "./url" }, { "identity": "servd", "map": "./Value" } ] }, { "path": "Practitioner.telecom.use", "short": "home | work | temp | old | mobile - purpose of this contact point", "definition": "Identifies the purpose for the contact point.", "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old contact etc for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.", "requirements": "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isModifier": true, "binding": { "name": "ContactPointUse", "strength": "required", "description": "Use of contact point", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/contact-point-use" } }, "mapping": [ { "identity": "v2", "map": "XTN.2 - but often indicated by field" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./ContactPointPurpose" } ] }, { "path": "Practitioner.telecom.period", "short": "Time period when the contact point was/is in use", "definition": "Time period when the contact point was/is in use.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "mapping": [ { "identity": "v2", "map": "N/A" }, { "identity": "rim", "map": "./useablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "path": "Practitioner.address", "short": "Where practitioner can be found/visited", "definition": "The postal address where the practitioner can be found or visited or to which mail can be delivered.", "requirements": "Need to keep track where the practitioner can found during work or for directing mail.", "min": 0, "max": "1", "type": [ { "code": "Address" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "ORC-24, STF-11, ROL-11, PRT-14" }, { "identity": "rim", "map": "./addr" }, { "identity": "servd", "map": "./Addresses" } ] }, { "path": "Practitioner.address.id", "representation": [ "xmlAttr" ], "short": "xml:id (or equivalent in JSON)", "definition": "unique id for the element within a resource (for internal references).", "min": 0, "max": "1", "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Practitioner.address.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "type": [ { "code": "Extension" } ] }, { "path": "Practitioner.address.extension", "name": "USLabCounty", "short": "County/Parish FIPS codes", "definition": "County/Parish FIPS codes.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/us-core-county" } ], "mustSupport": true, "binding": { "name": "USFIPSCounty", "strength": "required", "description": "FIPS codes for US counties and county equivalent entities", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/fips-county" } } }, { "path": "Practitioner.address.use", "short": "home | work | temp | old - purpose of this address", "definition": "The purpose of this address.", "comments": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old address etc for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.", "requirements": "Allows an appropriate address to be chosen from a list of many.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "exampleCode": "home", "mustSupport": true, "isModifier": true, "binding": { "name": "AddressUse", "strength": "required", "description": "The use of an address", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/address-use" } }, "mapping": [ { "identity": "v2", "map": "XAD.7" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./AddressPurpose" } ] }, { "path": "Practitioner.address.text", "short": "Text representation of the address", "definition": "A full text representation of the address.", "comments": "Can provide both a text representation and parts.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "exampleString": "137 Nowhere Street, Erewhon 9132", "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6" }, { "identity": "rim", "map": "./formatted" } ] }, { "path": "Practitioner.address.line", "short": "Street name, number, direction & P.O. Box etc", "definition": "This component contains the house number, apartment number, street name, street direction, \nP.O. Box number, delivery hints, and similar address information.", "requirements": "home | work | temp | old - purpose of this address.", "min": 0, "max": "2", "type": [ { "code": "string" } ], "exampleString": "137 Nowhere Street", "mustSupport": true, "mapping": [ { "identity": "vcard", "map": "street address" }, { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "path": "Practitioner.address.city", "short": "Name of city, town etc.", "definition": "The name of the city, town, village or other community or delivery center.", "alias": [ "Muncipality" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "exampleString": "Erewhon", "mustSupport": true, "mapping": [ { "identity": "vcard", "map": "locality" }, { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "path": "Practitioner.address.state", "short": "Sub-unit of country (abreviations ok)", "definition": "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "binding": { "name": "USPSState", "strength": "required", "description": "Two letter USPS alphabetic codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/usps-state" } }, "mapping": [ { "identity": "vcard", "map": "region" }, { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "servd", "map": "./Region" } ] }, { "path": "Practitioner.address.postalCode", "short": "US Zip Codes", "definition": "US Zip Codes.", "alias": [ "Zip" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "exampleString": "9132", "constraint": [ { "key": "inv-2", "name": "Regex for Zip", "severity": "error", "human": "(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} )" } ], "mustSupport": true, "mapping": [ { "identity": "vcard", "map": "postal code" }, { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "path": "Practitioner.address.country", "short": "ISO 3166 3 letter Country Code", "definition": "ISO 3166 3 letter Country Code.", "comments": "ISO 3166 3 letter codes can be used in place of a full country name.", "min": 0, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "binding": { "name": "USCountry", "strength": "extensible", "description": "ISO 2 letter Country Codes", "valueSetUri": "http://www.iso.org/iso/country_codes.htm" }, "mapping": [ { "identity": "vcard", "map": "country name" }, { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "servd", "map": "./Country" } ] }, { "path": "Practitioner.address.period", "short": "Time period when address was/is in use", "definition": "Time period when address was/is in use.", "requirements": "Allows addresses to be placed in historical context.", "min": 0, "max": "1", "type": [ { "code": "Period" } ], "examplePeriod": { "start": "2010-03-23", "end": "2010-07-01" }, "mapping": [ { "identity": "v2", "map": "XAD.12 / XAD.13 + XAD.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "path": "Practitioner.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", "requirements": "Needed to address the person correctly.", "min": 0, "max": "1", "type": [ { "code": "code" } ], "isSummary": true, "binding": { "name": "AdministrativeGender", "strength": "required", "description": "The gender of a person used for administrative purposes", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/administrative-gender" } }, "mapping": [ { "identity": "v2", "map": "STF-5" }, { "identity": "rim", "map": "./administrativeGender" }, { "identity": "servd", "map": "./GenderCode" } ] }, { "path": "Practitioner.birthDate", "short": "The date of birth for the practitioner", "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": "The list of Roles/Organizations that the Practitioner is associated with", "definition": "The list of Roles/Organizations that the Practitioner is associated with.", "min": 1, "max": "1", "mustSupport": true }, { "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": "Orderer's Organization", "definition": "A reference to the organization that placed the lab order. It could be a doctor's office, hospital or clinic.", "min": 1, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/org-uslab-uslaborderfacility" } ], "mustSupport": true }, { "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": { "name": "PractitionerRole", "strength": "example", "description": "The role a person plays representing an organization", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/practitioner-role" } }, "mapping": [ { "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": "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": { "name": "PractitionerSpecialty", "strength": "example", "description": "Specific specialty associated with the agency", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/practitioner-specialty" } }, "mapping": [ { "identity": "v2", "map": "PRA-5-specialty" }, { "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-date of certification" }, { "identity": "rim", "map": "./effectiveTime" }, { "identity": "servd", "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)" } ] }, { "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" } ], "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/>\rHowever these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)" } ] }, { "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" } ] }, { "path": "Practitioner.qualification", "short": "Qualifications obtained by training and certification", "definition": "Qualifications obtained by training and certification.", "min": 0, "max": "*", "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" } ] }, { "path": "Practitioner.qualification.code", "short": "Coded representation of the qualification", "definition": "Coded representation of the qualification.", "min": 1, "max": "1", "type": [ { "code": "CodeableConcept" } ], "binding": { "name": "Qualification", "strength": "example", "description": "Specific qualification the practitioner has to provide a service", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/anzsco-occupations" } }, "mapping": [ { "identity": "rim", "map": "./code" }, { "identity": "servd", "map": "./Qualifications.Value" } ] }, { "path": "Practitioner.qualification.period", "short": "Period during which the qualification is valid", "definition": "Period during which the qualification is valid.", "requirements": "Qualifications are often for a limited period of time, and can be revoked.", "min": 0, "max": "1", "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": { "name": "Language", "strength": "required", "description": "A human language", "valueSetUri": "http://tools.ietf.org/html/bcp47" }, "mapping": [ { "identity": "v2", "map": "PID-15, NK1-20, LAN-2" }, { "identity": "rim", "map": "./languageCode" }, { "identity": "servd", "map": "./Languages.LanguageSpokenCode" } ] } ] }, "differential": { "element": [ { "path": "Practitioner", "name": "USLabPHPract", "short": "USLab Practitioner", "definition": "This is the provider who either ordered a lab test or to whom the results have been sent.", "alias": [ "Provider", "Orderer", "Submitting Physician" ], "min": 1, "max": "1", "type": [ { "code": "Practitioner" } ], "constraint": [ { "key": "inv-1", "name": "NameandorID", "severity": "error", "human": "Shall have Organization.name and/or Organization.identifier.", "xpath": "exists(f:name) or exists(f:identifier)" } ] }, { "path": "Practitioner.identifier", "min": 0, "max": "1", "type": [ { "code": "Identifier" } ], "condition": [ "inv-1" ], "mustSupport": true }, { "path": "Practitioner.identifier.use", "min": 1, "max": "1", "mustSupport": true }, { "path": "Practitioner.identifier.system", "short": "OID for National Provider Identifier (NPI)", "definition": "See https://nppes.cms.hhs.gov/NPPES/.", "min": 1, "max": "1", "type": [ { "code": "uri" } ], "fixedUri": "urn:oid:2.16.840.1.113883.4.6", "mustSupport": true }, { "path": "Practitioner.identifier.value", "short": "NPI Provider Number", "definition": "NPI Provider Number.", "min": 1, "max": "1", "mustSupport": true }, { "path": "Practitioner.name", "min": 0, "max": "1", "type": [ { "code": "HumanName" } ], "condition": [ "inv-1" ], "mustSupport": true }, { "path": "Practitioner.name.family", "min": 1, "max": "1", "mustSupport": true }, { "path": "Practitioner.name.given", "min": 0, "max": "2", "mustSupport": true }, { "path": "Practitioner.name.prefix", "min": 0, "max": "1", "mustSupport": true }, { "path": "Practitioner.name.suffix", "min": 0, "max": "1", "mustSupport": true }, { "path": "Practitioner.telecom", "min": 0, "max": "2", "mustSupport": true }, { "path": "Practitioner.telecom.system", "min": 1, "max": "1", "mustSupport": true }, { "path": "Practitioner.telecom.value", "min": 1, "max": "1", "mustSupport": true }, { "path": "Practitioner.address", "min": 0, "max": "1", "type": [ { "code": "Address" } ], "mustSupport": true }, { "path": "Practitioner.address.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" } }, { "path": "Practitioner.address.extension", "name": "USLabCounty", "short": "County/Parish FIPS codes", "definition": "County/Parish FIPS codes.", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": "http://hl7.org/fhir/StructureDefinition/us-core-county" } ], "mustSupport": true, "binding": { "name": "USFIPSCounty", "strength": "required", "description": "FIPS codes for US counties and county equivalent entities", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/fips-county" } } }, { "path": "Practitioner.address.use", "min": 0, "max": "1", "mustSupport": true }, { "path": "Practitioner.address.line", "min": 0, "max": "2", "mustSupport": true }, { "path": "Practitioner.address.city", "min": 0, "max": "1", "mustSupport": true }, { "path": "Practitioner.address.state", "min": 0, "max": "1", "mustSupport": true, "binding": { "name": "USPSState", "strength": "required", "description": "Two letter USPS alphabetic codes.", "valueSetReference": { "reference": "http://hl7.org/fhir/vs/usps-state" } } }, { "path": "Practitioner.address.postalCode", "short": "US Zip Codes", "definition": "US Zip Codes.", "min": 0, "max": "1", "condition": [ "inv-2" ], "constraint": [ { "key": "inv-2", "name": "Regex for Zip", "severity": "error", "human": "(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} )" } ], "mustSupport": true }, { "path": "Practitioner.address.country", "short": "ISO 3166 3 letter Country Code", "definition": "ISO 3166 3 letter Country Code.", "min": 0, "max": "1", "mustSupport": true, "binding": { "name": "USCountry", "strength": "extensible", "description": "ISO 2 letter Country Codes", "valueSetUri": "http://www.iso.org/iso/country_codes.htm" } }, { "path": "Practitioner.practitionerRole", "min": 1, "max": "1", "mustSupport": true }, { "path": "Practitioner.practitionerRole.managingOrganization", "short": "Orderer's Organization", "definition": "A reference to the organization that placed the lab order. It could be a doctor's office, hospital or clinic.", "min": 1, "max": "1", "type": [ { "code": "Reference", "profile": "http://hl7.org/fhir/StructureDefinition/org-uslab-uslaborderfacility" } ], "mustSupport": true } ] } }