{ "description": "Base profile for Australian context Practitioner Role (Individual Provider)", "_filename": "StructureDefinition-au-practitionerrole.json", "package_name": "hl7.fhir.au.base", "date": "2017-03-11T17:30:54+11:00", "derivation": "constraint", "meta": { "lastUpdated": "2018-03-03T23:12:07.355+11:00" }, "publisher": "Health Level Seven Australia (Patient Administration WG)", "fhirVersion": "3.0.1", "name": "AUBasePractitionerRole", "mapping": [ { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://www.omg.org/spec/ServD/1.0/", "name": "ServD", "identity": "servd" }, { "uri": "http://hl7.org/fhir/w5", "name": "W5 Mapping", "identity": "w5" } ], "abstract": false, "type": "PractitionerRole", "experimental": null, "resourceType": "StructureDefinition", "title": "AU Base Practitioner Role", "package_version": "0.9.3", "snapshot": { "element": [ { "constraint": [ { "key": "dom-2", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "xpath": "not(parent::f:contained and f:contained)", "source": "DomainResource", "severity": "error", "expression": "contained.contained.empty()" }, { "key": "dom-1", "human": "If the resource is contained in another resource, it SHALL NOT contain any narrative", "xpath": "not(parent::f:contained and f:text)", "source": "DomainResource", "severity": "error", "expression": "contained.text.empty()" }, { "key": "dom-4", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "DomainResource", "severity": "error", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" }, { "key": "dom-3", "human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource", "xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))", "source": "DomainResource", "severity": "error", "expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()" } ], "path": "PractitionerRole", "min": 0, "definition": "A practitioner, at a location, performing a role.", "short": "A practitioner in a healthcare role in an Australian healthcare context", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "PRD (as one example)", "identity": "v2" }, { "map": "Role", "identity": "rim" }, { "map": "ServiceSiteProvider", "identity": "servd" }, { "map": "administrative.individual", "identity": "w5" } ], "max": "*", "id": "PractitionerRole", "base": { "max": "*", "min": 0, "path": "PractitionerRole" } }, { "path": "PractitionerRole.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "short": "Logical id of this artifact", "type": [ { "code": "id" } ], "max": "1", "id": "PractitionerRole.id", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "base": { "max": "1", "min": 0, "path": "Resource.id" }, "isSummary": true }, { "path": "PractitionerRole.meta", "min": 0, "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "max": "1", "id": "PractitionerRole.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "path": "PractitionerRole.implicitRules", "min": 0, "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.implicitRules", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "isSummary": true }, { "path": "PractitionerRole.language", "min": 0, "definition": "The base language in which the resource is written.", "short": "Language of the resource content", "type": [ { "code": "code" } ], "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueReference": { "reference": "http://hl7.org/fhir/ValueSet/all-languages" } }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "A human language.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/languages" } }, "max": "1", "id": "PractitionerRole.language", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "base": { "max": "1", "min": 0, "path": "Resource.language" } }, { "path": "PractitionerRole.text", "min": 0, "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "short": "Text summary of the resource, for human interpretation", "mapping": [ { "map": "Act.text?", "identity": "rim" } ], "type": [ { "code": "Narrative" } ], "alias": [ "narrative", "html", "xhtml", "display" ], "max": "1", "id": "PractitionerRole.text", "condition": [ "dom-1" ], "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" } }, { "path": "PractitionerRole.contained", "min": 0, "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "PractitionerRole.contained", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" } }, { "path": "PractitionerRole.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" } }, { "path": "PractitionerRole.modifierExtension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.modifierExtension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" } }, { "path": "PractitionerRole.identifier", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "definition": "Business identifiers for practitioner in a role.", "short": "Practitioner role identifiers", "mapping": [ { "map": "PRD-7 (or XCN.1)", "identity": "v2" }, { "map": ".id", "identity": "rim" }, { "map": "./Identifiers", "identity": "servd" }, { "map": "id", "identity": "w5" } ], "slicing": { "rules": "open", "discriminator": [ { "path": "system", "type": "value" }, { "path": "type", "type": "value" } ] }, "type": [ { "code": "Identifier" } ], "max": "*", "id": "PractitionerRole.identifier", "base": { "max": "*", "min": 0, "path": "PractitionerRole.identifier" }, "isSummary": true }, { "path": "PractitionerRole.identifier", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "definition": "Provider number for this practitioner role", "short": "Australian provider number", "mapping": [ { "map": "PRD-7 (or XCN.1)", "identity": "v2" }, { "map": ".id", "identity": "rim" }, { "map": "./Identifiers", "identity": "servd" }, { "map": "id", "identity": "w5" } ], "type": [ { "code": "Identifier" } ], "sliceName": "providerNumber", "max": "1", "id": "PractitionerRole.identifier:providerNumber", "base": { "max": "*", "min": 0, "path": "PractitionerRole.identifier" }, "isSummary": true }, { "path": "PractitionerRole.identifier.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:providerNumber.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "definition": "The purpose of this identifier.", "isModifier": true, "short": "usual | official | temp | secondary (If known)", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "max": "1", "id": "PractitionerRole.identifier:providerNumber.use", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 1, "definition": "Identifier type of provider number for this practitioner role", "short": "Provider Number Identifier Type", "mapping": [ { "map": "CX.5", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Local Identifier Type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203" } }, "max": "1", "id": "PractitionerRole.identifier:providerNumber.type", "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:providerNumber.type.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "definition": "Provider number identifier type coding", "short": "Provider Number Identifier Type Code", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.coding.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:providerNumber.type.coding.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "short": "Identity of the terminology system", "fixedUri": "http://hl7.org.au/fhir/v2/0203", "mapping": [ { "map": "C*E.3", "identity": "v2" }, { "map": "./codeSystem", "identity": "rim" }, { "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem", "identity": "orim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding.system", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Coding.system" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.version", "min": 0, "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.", "short": "Version of the system - if relevant", "mapping": [ { "map": "C*E.7", "identity": "v2" }, { "map": "./codeSystemVersion", "identity": "rim" }, { "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion", "identity": "orim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding.version", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Coding.version" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.code", "fixedCode": "UPIN", "requirements": "Need to refer to a particular code in the system.", "min": 1, "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).", "short": "Symbol in syntax defined by the system", "mapping": [ { "map": "C*E.1", "identity": "v2" }, { "map": "./code", "identity": "rim" }, { "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code", "identity": "orim" } ], "type": [ { "code": "code" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding.code", "base": { "max": "1", "min": 0, "path": "Coding.code" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "short": "Representation defined by the system", "mapping": [ { "map": "C*E.2 - but note this is not well followed", "identity": "v2" }, { "map": "CV.displayName", "identity": "rim" }, { "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding.display", "base": { "max": "1", "min": 0, "path": "Coding.display" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "short": "If this coding was chosen directly by the user", "mapping": [ { "map": "Sometimes implied by being first", "identity": "v2" }, { "map": "CD.codingRationale", "identity": "rim" }, { "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]", "identity": "orim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.type.coding.userSelected", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 1, "definition": "Provider number identifier type descriptive text", "short": "Provider Number Identifier Type Descriptive Text", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "fixedString": "Medicare Provider Number", "id": "PractitionerRole.identifier:providerNumber.type.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "path": "PractitionerRole.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "min": 1, "definition": "Namespace of provider number for this practitioner role", "short": "The namespace for the identifier value", "fixedUri": "http://ns.electronichealth.net.au/id/medicare-provider-number", "mapping": [ { "map": "CX.4 / EI-2-4", "identity": "v2" }, { "map": "II.root or Role.id.root", "identity": "rim" }, { "map": "./IdentifierType", "identity": "servd" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.system", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" } ], "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "isSummary": true }, { "path": "PractitionerRole.identifier.value", "min": 1, "definition": "Provider number for this practitioner role", "short": "Medicare Provider Number Value", "mapping": [ { "map": "CX.1 / EI.1", "identity": "v2" }, { "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)", "identity": "rim" }, { "map": "./Value", "identity": "servd" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.value", "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).", "example": [ { "label": "General", "valueString": "123456" }, { "label": "Provider number", "valueString": "2426621B" } ], "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "isSummary": true }, { "path": "PractitionerRole.identifier.period", "min": 0, "definition": "Time period during which identifier is/was valid for use.", "short": "Time period when id is/was valid for use", "mapping": [ { "map": "CX.7 + CX.8", "identity": "v2" }, { "map": "Role.effectiveTime or implied by context", "identity": "rim" }, { "map": "./StartDate and ./EndDate", "identity": "servd" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.period", "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner", "min": 0, "definition": "Organization that issued/manages the identifier.", "short": "Organization that issued id (may be just text)", "mapping": [ { "map": "CX.4 / (CX.4,CX.9,CX.10)", "identity": "v2" }, { "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper", "identity": "rim" }, { "map": "./IdentifierIssuingAuthority", "identity": "servd" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "max": "1", "id": "PractitionerRole.identifier:providerNumber.assigner", "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "isSummary": true }, { "path": "PractitionerRole.identifier", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "definition": "Combined HPI-I and HPI-O identifier to use as unique organisation based identifier for a practitioner.", "short": "Provider at Organisation Identifier", "mapping": [ { "map": "PRD-7 (or XCN.1)", "identity": "v2" }, { "map": ".id", "identity": "rim" }, { "map": "./Identifiers", "identity": "servd" }, { "map": "id", "identity": "w5" } ], "type": [ { "code": "Identifier" } ], "sliceName": "nationalProviderAtOrganisation", "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation", "base": { "max": "*", "min": 0, "path": "PractitionerRole.identifier" }, "isSummary": true }, { "path": "PractitionerRole.identifier.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "definition": "The purpose of this identifier.", "isModifier": true, "short": "usual | official | temp | secondary (If known)", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.use", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 1, "definition": "Identifier type provider at organisation identifier for this practitioner role", "short": "National Provider at Organisation Identifier Type", "mapping": [ { "map": "CX.5", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Local Identifier Type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203" } }, "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type", "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "short": "Code defined by a terminology system", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.coding.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "short": "Identity of the terminology system", "fixedUri": "http://hl7.org.au/fhir/v2/0203", "mapping": [ { "map": "C*E.3", "identity": "v2" }, { "map": "./codeSystem", "identity": "rim" }, { "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem", "identity": "orim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.system", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Coding.system" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.version", "min": 0, "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.", "short": "Version of the system - if relevant", "mapping": [ { "map": "C*E.7", "identity": "v2" }, { "map": "./codeSystemVersion", "identity": "rim" }, { "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion", "identity": "orim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.version", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Coding.version" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.code", "fixedCode": "NPIO", "requirements": "Need to refer to a particular code in the system.", "min": 1, "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).", "short": "Symbol in syntax defined by the system", "mapping": [ { "map": "C*E.1", "identity": "v2" }, { "map": "./code", "identity": "rim" }, { "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code", "identity": "orim" } ], "type": [ { "code": "code" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.code", "base": { "max": "1", "min": 0, "path": "Coding.code" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "short": "Representation defined by the system", "mapping": [ { "map": "C*E.2 - but note this is not well followed", "identity": "v2" }, { "map": "CV.displayName", "identity": "rim" }, { "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.display", "base": { "max": "1", "min": 0, "path": "Coding.display" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "short": "If this coding was chosen directly by the user", "mapping": [ { "map": "Sometimes implied by being first", "identity": "v2" }, { "map": "CD.codingRationale", "identity": "rim" }, { "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]", "identity": "orim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.userSelected", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 1, "definition": "National provider at organisation identifer type descriptive text", "short": "National Provider at Organisation Identifer Type Descriptive Text", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "fixedString": "NPIO", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "path": "PractitionerRole.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "min": 1, "definition": "Namespace of national provider at organisation identifier for this practitioner role", "short": "The namespace for the identifier value", "fixedUri": "http://hl7.org.au/id/npio", "mapping": [ { "map": "CX.4 / EI-2-4", "identity": "v2" }, { "map": "II.root or Role.id.root", "identity": "rim" }, { "map": "./IdentifierType", "identity": "servd" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.system", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" } ], "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "isSummary": true }, { "constraint": [ { "key": "inv-npio-0", "human": "NPIO length is exactly 33 characters", "severity": "error", "expression": "value.length() = 33" } ], "path": "PractitionerRole.identifier.value", "min": 1, "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "short": "NPIO Value", "mapping": [ { "map": "CX.1 / EI.1", "identity": "v2" }, { "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)", "identity": "rim" }, { "map": "./Value", "identity": "servd" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.value", "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).", "example": [ { "label": "General", "valueString": "123456" } ], "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "isSummary": true }, { "path": "PractitionerRole.identifier.period", "min": 0, "definition": "Time period during which identifier is/was valid for use.", "short": "Time period when id is/was valid for use", "mapping": [ { "map": "CX.7 + CX.8", "identity": "v2" }, { "map": "Role.effectiveTime or implied by context", "identity": "rim" }, { "map": "./StartDate and ./EndDate", "identity": "servd" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.period", "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner", "min": 0, "definition": "Organization that issued/manages the identifier.", "short": "Organization that issued id (may be just text)", "mapping": [ { "map": "CX.4 / (CX.4,CX.9,CX.10)", "identity": "v2" }, { "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper", "identity": "rim" }, { "map": "./IdentifierIssuingAuthority", "identity": "servd" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "max": "1", "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.assigner", "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "isSummary": true }, { "path": "PractitionerRole.identifier", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "definition": "An identifier that applies to this person in this role. This identifier is used for qualified identifiers to represent a My Health Record Care Agency Employees Identifier (CAE-I) numbers. ", "short": "Care Agency Employee Identifier", "mapping": [ { "map": "PRD-7 (or XCN.1)", "identity": "v2" }, { "map": ".id", "identity": "rim" }, { "map": "./Identifiers", "identity": "servd" }, { "map": "id", "identity": "w5" } ], "type": [ { "code": "Identifier" } ], "sliceName": "careAgencyEmployeeIdentifier", "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier", "base": { "max": "*", "min": 0, "path": "PractitionerRole.identifier" }, "isSummary": true }, { "path": "PractitionerRole.identifier.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "definition": "The purpose of this identifier.", "isModifier": true, "short": "usual | official | temp | secondary (If known)", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.use", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 1, "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "short": "Description of identifier", "mapping": [ { "map": "CX.5", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "extensible", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-type" } }, "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type", "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "short": "Code defined by a terminology system", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "max": "*", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 1, "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "short": "Plain text representation of the concept", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "fixedString": "Care Agency Employee Identifier", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "path": "PractitionerRole.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "min": 1, "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "short": "The namespace for the identifier value", "fixedUri": "http://ns.electronichealth.net.au/id/pcehr/caei/1.0", "mapping": [ { "map": "CX.4 / EI-2-4", "identity": "v2" }, { "map": "II.root or Role.id.root", "identity": "rim" }, { "map": "./IdentifierType", "identity": "servd" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.system", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" } ], "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "isSummary": true }, { "constraint": [ { "key": "inv-caei-0", "human": "The CAEI shall be an exactly 16 digit number", "severity": "error", "expression": "matches('^([0-9]{16})$')", "requirements": "The value shall be a 16 digit number." }, { "key": "inv-caei-1", "human": "The CAEI SHALL contain a prefix of 900360", "severity": "error", "expression": "startsWith('900360')" }, { "key": "inv-caei-2", "human": "The CAEI shall pass the Luhn algorithm check", "severity": "error", "expression": "(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)" } ], "path": "PractitionerRole.identifier.value", "min": 1, "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "short": "CAEI Number Value", "mapping": [ { "map": "CX.1 / EI.1", "identity": "v2" }, { "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)", "identity": "rim" }, { "map": "./Value", "identity": "servd" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.value", "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).", "example": [ { "label": "General", "valueString": "123456" } ], "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "isSummary": true }, { "path": "PractitionerRole.identifier.period", "min": 0, "definition": "Time period during which identifier is/was valid for use.", "short": "Time period when id is/was valid for use", "mapping": [ { "map": "CX.7 + CX.8", "identity": "v2" }, { "map": "Role.effectiveTime or implied by context", "identity": "rim" }, { "map": "./StartDate and ./EndDate", "identity": "servd" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.period", "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner", "min": 0, "definition": "Organization that issued/manages the identifier.", "short": "Organization that issued id (may be just text)", "mapping": [ { "map": "CX.4 / (CX.4,CX.9,CX.10)", "identity": "v2" }, { "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper", "identity": "rim" }, { "map": "./IdentifierIssuingAuthority", "identity": "servd" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "max": "1", "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.assigner", "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "isSummary": true }, { "path": "PractitionerRole.identifier", "requirements": "Often, specific identities are assigned for the agent.", "min": 0, "definition": "Assigned identifier related to employment in this role", "short": "Employee Number", "mapping": [ { "map": "PRD-7 (or XCN.1)", "identity": "v2" }, { "map": ".id", "identity": "rim" }, { "map": "./Identifiers", "identity": "servd" }, { "map": "id", "identity": "w5" } ], "type": [ { "code": "Identifier" } ], "sliceName": "employeeNumber", "max": "*", "id": "PractitionerRole.identifier:employeeNumber", "base": { "max": "*", "min": 0, "path": "PractitionerRole.identifier" }, "isSummary": true }, { "path": "PractitionerRole.identifier.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:employeeNumber.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.use", "requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.", "min": 0, "definition": "The purpose of this identifier.", "isModifier": true, "short": "usual | official | temp | secondary (If known)", "mapping": [ { "map": "N/A", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierUse" } ], "description": "Identifies the purpose for this identifier, if known .", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/identifier-use" } }, "max": "1", "id": "PractitionerRole.identifier:employeeNumber.use", "comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.", "base": { "max": "1", "min": 0, "path": "Identifier.use" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type", "requirements": "Allows users to make use of identifiers when the identifier system is not known.", "min": 1, "definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.", "short": "Description of identifier", "mapping": [ { "map": "CX.5", "identity": "v2" }, { "map": "Role.code or implied by context", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Local Identifier Type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203" } }, "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type", "comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.", "base": { "max": "1", "min": 0, "path": "Identifier.type" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:employeeNumber.type.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding", "requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.", "min": 0, "definition": "A reference to a code defined by a terminology system.", "short": "Code defined by a terminology system", "mapping": [ { "map": "C*E.1-8, C*E.10-22", "identity": "v2" }, { "map": "union(., ./translation)", "identity": "rim" }, { "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding", "identity": "orim" } ], "type": [ { "code": "Coding" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "base": { "max": "*", "min": 0, "path": "CodeableConcept.coding" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.type.coding.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:employeeNumber.type.coding.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.type.coding.system", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "short": "Identity of the terminology system", "fixedUri": "http://hl7.org/fhir/v2/0203", "mapping": [ { "map": "C*E.3", "identity": "v2" }, { "map": "./codeSystem", "identity": "rim" }, { "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem", "identity": "orim" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding.system", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Coding.system" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.version", "min": 0, "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.", "short": "Version of the system - if relevant", "mapping": [ { "map": "C*E.7", "identity": "v2" }, { "map": "./codeSystemVersion", "identity": "rim" }, { "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion", "identity": "orim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding.version", "comment": "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.", "base": { "max": "1", "min": 0, "path": "Coding.version" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.code", "fixedCode": "EI", "requirements": "Need to refer to a particular code in the system.", "min": 1, "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).", "short": "Symbol in syntax defined by the system", "mapping": [ { "map": "C*E.1", "identity": "v2" }, { "map": "./code", "identity": "rim" }, { "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code", "identity": "orim" } ], "type": [ { "code": "code" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding.code", "base": { "max": "1", "min": 0, "path": "Coding.code" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.display", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 0, "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "short": "Representation defined by the system", "mapping": [ { "map": "C*E.2 - but note this is not well followed", "identity": "v2" }, { "map": "CV.displayName", "identity": "rim" }, { "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding.display", "base": { "max": "1", "min": 0, "path": "Coding.display" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.coding.userSelected", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).", "short": "If this coding was chosen directly by the user", "mapping": [ { "map": "Sometimes implied by being first", "identity": "v2" }, { "map": "CD.codingRationale", "identity": "rim" }, { "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]", "identity": "orim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.type.coding.userSelected", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "base": { "max": "1", "min": 0, "path": "Coding.userSelected" }, "isSummary": true }, { "path": "PractitionerRole.identifier.type.text", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 1, "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "short": "Plain text representation of the concept", "mapping": [ { "map": "C*E.9. But note many systems use C*E.2 for this", "identity": "v2" }, { "map": "./originalText[mediaType/code=\"text/plain\"]/data", "identity": "rim" }, { "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText", "identity": "orim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "fixedString": "Employee Number", "id": "PractitionerRole.identifier:employeeNumber.type.text", "comment": "Very often the text is the same as a displayName of one of the codings.", "base": { "max": "1", "min": 0, "path": "CodeableConcept.text" }, "isSummary": true }, { "path": "PractitionerRole.identifier.system", "requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.", "min": 0, "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.", "short": "The namespace for the identifier value", "mapping": [ { "map": "CX.4 / EI-2-4", "identity": "v2" }, { "map": "II.root or Role.id.root", "identity": "rim" }, { "map": "./IdentifierType", "identity": "servd" } ], "type": [ { "code": "uri" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.system", "example": [ { "label": "General", "valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri" } ], "base": { "max": "1", "min": 0, "path": "Identifier.system" }, "isSummary": true }, { "path": "PractitionerRole.identifier.value", "min": 1, "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "short": "Employee Number Value", "mapping": [ { "map": "CX.1 / EI.1", "identity": "v2" }, { "map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)", "identity": "rim" }, { "map": "./Value", "identity": "servd" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.value", "comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).", "example": [ { "label": "General", "valueString": "123456" } ], "base": { "max": "1", "min": 0, "path": "Identifier.value" }, "isSummary": true }, { "path": "PractitionerRole.identifier.period", "min": 0, "definition": "Time period during which identifier is/was valid for use.", "short": "Time period when id is/was valid for use", "mapping": [ { "map": "CX.7 + CX.8", "identity": "v2" }, { "map": "Role.effectiveTime or implied by context", "identity": "rim" }, { "map": "./StartDate and ./EndDate", "identity": "servd" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.period", "base": { "max": "1", "min": 0, "path": "Identifier.period" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner", "min": 1, "definition": "Organization that issued/manages the identifier.", "short": "Employing organisation", "mapping": [ { "map": "CX.4 / (CX.4,CX.9,CX.10)", "identity": "v2" }, { "map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper", "identity": "rim" }, { "map": "./IdentifierIssuingAuthority", "identity": "servd" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.assigner", "comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.", "base": { "max": "1", "min": 0, "path": "Identifier.assigner" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.assigner.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.identifier.assigner.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "slicing": { "rules": "open", "description": "Extensions are always sliced by (at least) url", "discriminator": [ { "path": "url", "type": "value" } ] }, "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.identifier:employeeNumber.assigner.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.identifier.assigner.reference", "min": 0, "definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.", "short": "Literal reference, Relative, internal or absolute URL", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.assigner.reference", "condition": [ "ref-1" ], "comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.", "base": { "max": "1", "min": 0, "path": "Reference.reference" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner.identifier", "min": 0, "definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.", "short": "Logical reference, when literal reference is not known", "mapping": [ { "map": ".identifier", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.assigner.identifier", "comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.", "base": { "max": "1", "min": 0, "path": "Reference.identifier" }, "isSummary": true }, { "path": "PractitionerRole.identifier.assigner.display", "min": 1, "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "short": "Employing organisation name", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "string" } ], "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "max": "1", "id": "PractitionerRole.identifier:employeeNumber.assigner.display", "comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.", "base": { "max": "1", "min": 0, "path": "Reference.display" }, "isSummary": true }, { "path": "PractitionerRole.active", "requirements": "Need to be able to mark a practitioner record as not to be used because it was created in error.", "min": 0, "definition": "Whether this practitioner's record is in active use.", "short": "Whether this practitioner's record is in active use", "mapping": [ { "map": "STF-7", "identity": "v2" }, { "map": ".statusCode", "identity": "rim" }, { "map": "status", "identity": "w5" } ], "type": [ { "code": "boolean" } ], "defaultValueBoolean": true, "max": "1", "id": "PractitionerRole.active", "comment": "Default is true. \r\rIf the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.", "base": { "max": "1", "min": 0, "path": "PractitionerRole.active" }, "isSummary": true }, { "path": "PractitionerRole.period", "requirements": "Even after the agencies is revoked, the fact that it existed must still be recorded.", "min": 0, "definition": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.", "short": "The period during which the practitioner is authorized to perform in these role(s)", "mapping": [ { "map": "PRD-8/9 / PRA-5.4", "identity": "v2" }, { "map": ".performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime", "identity": "rim" }, { "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)", "identity": "servd" }, { "map": "when.done", "identity": "w5" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "PractitionerRole.period", "base": { "max": "1", "min": 0, "path": "PractitionerRole.period" }, "isSummary": true }, { "path": "PractitionerRole.practitioner", "min": 0, "definition": "Practitioner that is able to provide the defined services for the organation.", "short": "Practitioner in this role", "mapping": [ { "map": ".player", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner" } ], "max": "1", "id": "PractitionerRole.practitioner", "base": { "max": "1", "min": 0, "path": "PractitionerRole.practitioner" }, "isSummary": true }, { "path": "PractitionerRole.organization", "min": 0, "definition": "The organization where the Practitioner performs the roles associated.", "short": "Organisation managing this role", "mapping": [ { "map": ".scoper", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-organisation" } ], "max": "1", "id": "PractitionerRole.organization", "base": { "max": "1", "min": 0, "path": "PractitionerRole.organization" }, "isSummary": true }, { "path": "PractitionerRole.code", "requirements": "Need to know what authority the practitioner has - what can they do?", "min": 0, "definition": "Roles which this practitioner is authorized to perform for the organization.", "short": "Roles which this practitioner may perform", "mapping": [ { "map": "PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17", "identity": "v2" }, { "map": ".code", "identity": "rim" }, { "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)", "identity": "servd" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PractitionerRole" } ], "description": "The role a person plays representing an organization", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/practitioner-role" } }, "max": "*", "id": "PractitionerRole.code", "comment": "A person may have more than one role. At least one role is required.", "base": { "max": "*", "min": 0, "path": "PractitionerRole.code" }, "isSummary": true }, { "path": "PractitionerRole.specialty", "min": 0, "definition": "Specific specialty of the practitioner.", "short": "Practitioner specialties", "mapping": [ { "map": "PRA-5", "identity": "v2" }, { "map": ".player.HealthCareProvider[@classCode = 'PROV'].code", "identity": "rim" }, { "map": "./Specialty", "identity": "servd" } ], "slicing": { "rules": "open", "discriminator": [ { "path": "coding.system", "type": "value" } ] }, "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PractitionerSpecialty" } ], "description": "Specific specialty associated with the agency", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/c80-practice-codes" } }, "max": "*", "id": "PractitionerRole.specialty", "base": { "max": "*", "min": 0, "path": "PractitionerRole.specialty" }, "isSummary": true }, { "path": "PractitionerRole.specialty", "min": 0, "definition": "Specialties for which this practitioner has capability to deliver in this role coded as SNOMED", "short": "SNOMED Practitioner Specialty", "mapping": [ { "map": "PRA-5", "identity": "v2" }, { "map": ".player.HealthCareProvider[@classCode = 'PROV'].code", "identity": "rim" }, { "map": "./Specialty", "identity": "servd" } ], "type": [ { "code": "CodeableConcept" } ], "sliceName": "snomedRole", "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PractitionerSpecialty" } ], "description": "Used to categorize the SNOMED provider role type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/snomed-practitioner-role" } }, "max": "*", "id": "PractitionerRole.specialty:snomedRole", "base": { "max": "*", "min": 0, "path": "PractitionerRole.specialty" }, "isSummary": true }, { "path": "PractitionerRole.location", "min": 0, "definition": "Single location of provision of services for this role. This is aligned with the use of an associated location specific Medicare Provider Number.", "short": "Location of Provider", "mapping": [ { "map": ".performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']", "identity": "rim" }, { "map": "(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location)", "identity": "servd" }, { "map": "where", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-location" } ], "max": "1", "id": "PractitionerRole.location", "base": { "max": "*", "min": 0, "path": "PractitionerRole.location" }, "isSummary": true }, { "path": "PractitionerRole.healthcareService", "min": 0, "definition": "The list of healthcare services that this worker provides for this role's Organization/Location(s).", "short": "The list of healthcare services that this worker provides for this role's Organization/Location(s)", "mapping": [ { "map": "EDU-2 / AFF-3", "identity": "v2" }, { "map": ".player.QualifiedEntity[@classCode = 'QUAL'].code", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice" } ], "max": "*", "id": "PractitionerRole.healthcareService", "base": { "max": "*", "min": 0, "path": "PractitionerRole.healthcareService" } }, { "path": "PractitionerRole.telecom", "requirements": "Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.", "min": 0, "definition": "Contact details that are specific to the role/location/service.", "short": "Contact details that are specific to the role/location/service", "mapping": [ { "map": ".telecom", "identity": "rim" } ], "type": [ { "code": "ContactPoint" } ], "max": "*", "id": "PractitionerRole.telecom", "base": { "max": "*", "min": 0, "path": "PractitionerRole.telecom" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" } ], "path": "PractitionerRole.availableTime", "min": 0, "definition": "A collection of times that the Service Site is available.", "short": "Times the Service Site is available", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "*", "id": "PractitionerRole.availableTime", "comment": "More detailed availability information may be provided in associated Schedule/Slot resources.", "base": { "max": "*", "min": 0, "path": "PractitionerRole.availableTime" } }, { "path": "PractitionerRole.availableTime.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.availableTime.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.availableTime.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.availableTime.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.availableTime.modifierExtension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "PractitionerRole.availableTime.modifierExtension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "PractitionerRole.availableTime.daysOfWeek", "min": 0, "definition": "Indicates which days of the week are available between the start and end Times.", "short": "mon | tue | wed | thu | fri | sat | sun", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "code" } ], "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "DaysOfWeek" } ], "description": "The days of the week.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/days-of-week" } }, "max": "*", "id": "PractitionerRole.availableTime.daysOfWeek", "base": { "max": "*", "min": 0, "path": "PractitionerRole.availableTime.daysOfWeek" } }, { "path": "PractitionerRole.availableTime.allDay", "min": 0, "definition": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.", "short": "Always available? e.g. 24 hour service", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "boolean" } ], "max": "1", "id": "PractitionerRole.availableTime.allDay", "base": { "max": "1", "min": 0, "path": "PractitionerRole.availableTime.allDay" } }, { "path": "PractitionerRole.availableTime.availableStartTime", "min": 0, "definition": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.", "short": "Opening time of day (ignored if allDay = true)", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "time" } ], "max": "1", "id": "PractitionerRole.availableTime.availableStartTime", "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "base": { "max": "1", "min": 0, "path": "PractitionerRole.availableTime.availableStartTime" } }, { "path": "PractitionerRole.availableTime.availableEndTime", "min": 0, "definition": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.", "short": "Closing time of day (ignored if allDay = true)", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "time" } ], "max": "1", "id": "PractitionerRole.availableTime.availableEndTime", "comment": "The timezone is expected to be for where this HealthcareService is provided at.", "base": { "max": "1", "min": 0, "path": "PractitionerRole.availableTime.availableEndTime" } }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "Element", "severity": "error", "expression": "hasValue() | (children().count() > id.count())" } ], "path": "PractitionerRole.notAvailable", "min": 0, "definition": "The HealthcareService is not available during this period of time due to the provided reason.", "short": "Not available during this time due to provided reason", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "BackboneElement" } ], "max": "*", "id": "PractitionerRole.notAvailable", "base": { "max": "*", "min": 0, "path": "PractitionerRole.notAvailable" } }, { "path": "PractitionerRole.notAvailable.id", "min": 0, "definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "short": "xml:id (or equivalent in JSON)", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "representation": [ "xmlAttr" ], "max": "1", "id": "PractitionerRole.notAvailable.id", "base": { "max": "1", "min": 0, "path": "Element.id" } }, { "path": "PractitionerRole.notAvailable.extension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "short": "Additional Content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "PractitionerRole.notAvailable.extension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "Element.extension" } }, { "path": "PractitionerRole.notAvailable.modifierExtension", "min": 0, "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "PractitionerRole.notAvailable.modifierExtension", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isSummary": true }, { "path": "PractitionerRole.notAvailable.description", "min": 1, "definition": "The reason that can be presented to the user as to why this time is not available.", "short": "Reason presented to the user explaining why time not available", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.notAvailable.description", "base": { "max": "1", "min": 1, "path": "PractitionerRole.notAvailable.description" } }, { "path": "PractitionerRole.notAvailable.during", "min": 0, "definition": "Service is not available (seasonally or for a public holiday) from this date.", "short": "Service not availablefrom this date", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "Period" } ], "max": "1", "id": "PractitionerRole.notAvailable.during", "base": { "max": "1", "min": 0, "path": "PractitionerRole.notAvailable.during" } }, { "path": "PractitionerRole.availabilityExceptions", "min": 0, "definition": "A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.", "short": "Description of availability exceptions", "mapping": [ { "map": ".effectiveTime", "identity": "rim" } ], "type": [ { "code": "string" } ], "max": "1", "id": "PractitionerRole.availabilityExceptions", "base": { "max": "1", "min": 0, "path": "PractitionerRole.availabilityExceptions" } }, { "path": "PractitionerRole.endpoint", "requirements": "Organizations have multiple systems that provide various services and ,ay also be different for practitioners too.\r\rSo the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.", "min": 0, "definition": "Technical endpoints providing access to services operated for the practitioner with this role.", "short": "Technical endpoints providing access to services operated for the practitioner with this role", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": "http://hl7.org/fhir/StructureDefinition/Endpoint" } ], "max": "*", "id": "PractitionerRole.endpoint", "base": { "max": "*", "min": 0, "path": "PractitionerRole.endpoint" } } ] }, "status": "draft", "id": "4a05240f-d20e-4a31-ae30-41183308573c", "kind": "resource", "url": "http://hl7.org.au/fhir/StructureDefinition/au-practitionerrole", "version": "0.1", "differential": { "element": [ { "id": "PractitionerRole", "path": "PractitionerRole", "short": "A practitioner in a healthcare role in an Australian healthcare context", "definition": "A practitioner, at a location, performing a role." }, { "id": "PractitionerRole.identifier", "path": "PractitionerRole.identifier", "short": "Practitioner role identifiers", "slicing": { "rules": "open", "discriminator": [ { "path": "system", "type": "value" }, { "path": "type", "type": "value" } ] }, "definition": "Business identifiers for practitioner in a role." }, { "id": "PractitionerRole.identifier:providerNumber", "max": "1", "path": "PractitionerRole.identifier", "short": "Australian provider number", "sliceName": "providerNumber", "definition": "Provider number for this practitioner role" }, { "id": "PractitionerRole.identifier:providerNumber.type", "min": 1, "path": "PractitionerRole.identifier.type", "short": "Provider Number Identifier Type", "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Local Identifier Type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203" } }, "definition": "Identifier type of provider number for this practitioner role" }, { "id": "PractitionerRole.identifier:providerNumber.type.coding", "max": "1", "path": "PractitionerRole.identifier.type.coding", "short": "Provider Number Identifier Type Code", "definition": "Provider number identifier type coding" }, { "id": "PractitionerRole.identifier:providerNumber.type.coding.system", "min": 1, "path": "PractitionerRole.identifier.type.coding.system", "fixedUri": "http://hl7.org.au/fhir/v2/0203" }, { "id": "PractitionerRole.identifier:providerNumber.type.coding.code", "min": 1, "path": "PractitionerRole.identifier.type.coding.code", "fixedCode": "UPIN" }, { "id": "PractitionerRole.identifier:providerNumber.type.text", "min": 1, "path": "PractitionerRole.identifier.type.text", "short": "Provider Number Identifier Type Descriptive Text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "definition": "Provider number identifier type descriptive text", "fixedString": "Medicare Provider Number" }, { "id": "PractitionerRole.identifier:providerNumber.system", "min": 1, "path": "PractitionerRole.identifier.system", "fixedUri": "http://ns.electronichealth.net.au/id/medicare-provider-number", "definition": "Namespace of provider number for this practitioner role" }, { "id": "PractitionerRole.identifier:providerNumber.value", "min": 1, "path": "PractitionerRole.identifier.value", "short": "Medicare Provider Number Value", "example": [ { "label": "Provider number", "valueString": "2426621B" } ], "definition": "Provider number for this practitioner role" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation", "max": "1", "path": "PractitionerRole.identifier", "short": "Provider at Organisation Identifier", "sliceName": "nationalProviderAtOrganisation", "definition": "Combined HPI-I and HPI-O identifier to use as unique organisation based identifier for a practitioner." }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type", "min": 1, "path": "PractitionerRole.identifier.type", "short": "National Provider at Organisation Identifier Type", "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Local Identifier Type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203" } }, "definition": "Identifier type provider at organisation identifier for this practitioner role" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding", "max": "1", "path": "PractitionerRole.identifier.type.coding" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.system", "min": 1, "path": "PractitionerRole.identifier.type.coding.system", "fixedUri": "http://hl7.org.au/fhir/v2/0203" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.coding.code", "min": 1, "path": "PractitionerRole.identifier.type.coding.code", "fixedCode": "NPIO" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.type.text", "min": 1, "path": "PractitionerRole.identifier.type.text", "short": "National Provider at Organisation Identifer Type Descriptive Text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "definition": "National provider at organisation identifer type descriptive text", "fixedString": "NPIO" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.system", "min": 1, "path": "PractitionerRole.identifier.system", "fixedUri": "http://hl7.org.au/id/npio", "definition": "Namespace of national provider at organisation identifier for this practitioner role" }, { "id": "PractitionerRole.identifier:nationalProviderAtOrganisation.value", "min": 1, "path": "PractitionerRole.identifier.value", "short": "NPIO Value", "constraint": [ { "key": "inv-npio-0", "human": "NPIO length is exactly 33 characters", "severity": "error", "expression": "value.length() = 33" } ] }, { "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier", "max": "1", "path": "PractitionerRole.identifier", "short": "Care Agency Employee Identifier", "sliceName": "careAgencyEmployeeIdentifier", "definition": "An identifier that applies to this person in this role. This identifier is used for qualified identifiers to represent a My Health Record Care Agency Employees Identifier (CAE-I) numbers. " }, { "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type", "min": 1, "path": "PractitionerRole.identifier.type" }, { "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.type.text", "min": 1, "path": "PractitionerRole.identifier.type.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "fixedString": "Care Agency Employee Identifier" }, { "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.system", "min": 1, "path": "PractitionerRole.identifier.system", "fixedUri": "http://ns.electronichealth.net.au/id/pcehr/caei/1.0" }, { "id": "PractitionerRole.identifier:careAgencyEmployeeIdentifier.value", "min": 1, "path": "PractitionerRole.identifier.value", "short": "CAEI Number Value", "constraint": [ { "key": "inv-caei-0", "human": "The CAEI shall be an exactly 16 digit number", "severity": "error", "expression": "matches('^([0-9]{16})$')", "requirements": "The value shall be a 16 digit number." }, { "key": "inv-caei-1", "human": "The CAEI SHALL contain a prefix of 900360", "severity": "error", "expression": "startsWith('900360')" }, { "key": "inv-caei-2", "human": "The CAEI shall pass the Luhn algorithm check", "severity": "error", "expression": "(((select(substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(1,1).toInteger())+(select(substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(3,1).toInteger())+(select(substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(5,1).toInteger())+(select(substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(7,1).toInteger())+(select(substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(9,1).toInteger())+(select(substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(11,1).toInteger())+(select(substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(13,1).toInteger())+(select(substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(substring(15,1).toInteger()))mod 10=0)" } ] }, { "id": "PractitionerRole.identifier:employeeNumber", "path": "PractitionerRole.identifier", "short": "Employee Number", "sliceName": "employeeNumber", "definition": "Assigned identifier related to employment in this role" }, { "id": "PractitionerRole.identifier:employeeNumber.type", "min": 1, "path": "PractitionerRole.identifier.type", "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "IdentifierType" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "description": "Local Identifier Type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203" } } }, { "id": "PractitionerRole.identifier:employeeNumber.type.coding", "max": "1", "path": "PractitionerRole.identifier.type.coding" }, { "id": "PractitionerRole.identifier:employeeNumber.type.coding.system", "min": 1, "path": "PractitionerRole.identifier.type.coding.system", "fixedUri": "http://hl7.org/fhir/v2/0203" }, { "id": "PractitionerRole.identifier:employeeNumber.type.coding.code", "min": 1, "path": "PractitionerRole.identifier.type.coding.code", "fixedCode": "EI" }, { "id": "PractitionerRole.identifier:employeeNumber.type.text", "min": 1, "path": "PractitionerRole.identifier.type.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "fixedString": "Employee Number" }, { "id": "PractitionerRole.identifier:employeeNumber.value", "min": 1, "path": "PractitionerRole.identifier.value", "short": "Employee Number Value" }, { "id": "PractitionerRole.identifier:employeeNumber.assigner", "min": 1, "path": "PractitionerRole.identifier.assigner", "short": "Employing organisation" }, { "id": "PractitionerRole.identifier:employeeNumber.assigner.display", "min": 1, "path": "PractitionerRole.identifier.assigner.display", "short": "Employing organisation name", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ] }, { "id": "PractitionerRole.practitioner", "path": "PractitionerRole.practitioner", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-practitioner" } ], "short": "Practitioner in this role" }, { "id": "PractitionerRole.organization", "path": "PractitionerRole.organization", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-organisation" } ], "short": "Organisation managing this role" }, { "id": "PractitionerRole.specialty", "path": "PractitionerRole.specialty", "short": "Practitioner specialties", "slicing": { "rules": "open", "discriminator": [ { "path": "coding.system", "type": "value" } ] } }, { "id": "PractitionerRole.specialty:snomedRole", "path": "PractitionerRole.specialty", "short": "SNOMED Practitioner Specialty", "binding": { "strength": "required", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PractitionerSpecialty" } ], "description": "Used to categorize the SNOMED provider role type", "valueSetReference": { "reference": "http://hl7.org.au/fhir/ValueSet/snomed-practitioner-role" } }, "sliceName": "snomedRole", "definition": "Specialties for which this practitioner has capability to deliver in this role coded as SNOMED" }, { "id": "PractitionerRole.location", "max": "1", "path": "PractitionerRole.location", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-location" } ], "short": "Location of Provider", "definition": "Single location of provision of services for this role. This is aligned with the use of an associated location specific Medicare Provider Number." }, { "id": "PractitionerRole.healthcareService", "path": "PractitionerRole.healthcareService", "type": [ { "code": "Reference", "targetProfile": "http://hl7.org.au/fhir/StructureDefinition/au-healthcareservice" } ] } ] }, "contact": [ { "telecom": [ { "use": "work", "value": "http://hl7.org.au", "system": "url" } ] } ], "baseDefinition": "http://hl7.org/fhir/StructureDefinition/PractitionerRole" }