My Health Record FHIR IG
1.2.0 - active
My Health Record FHIR IG - Local Development build (v1.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Active as of 2024-09-19 |
Definitions for the dh-practitioner-core-1 resource profile.
Guidance on how to interpret the contents of this table can be found here
0. Practitioner | |
2. Practitioner.active | |
Fixed Value | true |
4. Practitioner.qualification | |
Must Support | true |
Invariants | inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display (issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) ) |
6. Practitioner.qualification.issuer | |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here
0. Practitioner | |||||||
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. | ||||||
Short | A person with a formal responsibility in the provisioning of servicesA person with a formal responsibility in the provisioning of healthcare or related services | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) )inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) )inv-pra-4: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) )inv-pra-5: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type')) )inv-pra-6: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) ) | ||||||
2. Practitioner.implicitRules | |||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||
Short | A set of rules under which this content was created | ||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
4. Practitioner.extension:genderIdentity | |||||||
Slice Name | genderIdentity | ||||||
Definition | An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else. | ||||||
Short | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply | ||||||
Comments | Individual Gender identity Gender Identity Response (Extensible). See Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 for further materials. | ||||||
Control | 0..* This element is affected by the following invariants: inv-pra-3 | ||||||
Type | Extension(Individual Gender Identity) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
6. Practitioner.extension:individualPronouns | |||||||
Slice Name | individualPronouns | ||||||
Definition | The pronouns to use when referring to an individual in verbal or written communication. | ||||||
Short | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply | ||||||
Comments | Individual Pronouns Australian Pronouns (Extensible). | ||||||
Control | 0..* This element is affected by the following invariants: inv-pra-1 | ||||||
Type | Extension(Individual Pronouns) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
8. Practitioner.extension:recordedSexOrGender | |||||||
Slice Name | recordedSexOrGender | ||||||
Definition | A sex or gender property for the individual from a document or other record | ||||||
Short | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply | ||||||
Comments | Person Recorded Sex Or Gender type AU Recorded Sex or Gender Type (extensible). Person Recorded Sex Or Gender source document AU Recorded Sex or Gender (RSG) Source Document Type (extensible). Person Recorded Sex Or Gender jurisdiction Jurisdiction ValueSet - AU Extended (extensible). | ||||||
Control | 0..* This element is affected by the following invariants: inv-pra-4, inv-pra-5, inv-pra-6 | ||||||
Type | Extension(Person Recorded Sex Or Gender) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
10. Practitioner.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Summary | false | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
12. Practitioner.identifier | |||||||
Definition | An identifier that applies to this person in this role. | ||||||
Short | An identifier intended for computationAn identifier for the person as this agent | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(Identifier, AU HPI-I, AU PBS Prescriber Number, AU Care Agency Employee Identifier, AU Ahpra Registration Number) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Slicing | This element introduces a set of slices on Practitioner.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
14. Practitioner.identifier:hpii | |||||||
Slice Name | hpii | ||||||
Definition | Healthcare Provider Identifier for Individuals (HPI-I) assigned under the HI Service to healthcare providers involved in providing patient care. An identifier that applies to this person in this role. | ||||||
Short | Healthcare Provider Identifier – Individual (HPI-I)An identifier for the person as this agent | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..1* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(AU HPI-I) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-hpii-0: HPI-I shall be 16 digits ( value.matches('^([0-9]{16})$') )inv-hpii-1: HPI-I prefix shall be 800361 ( value.startsWith('800361') )inv-hpii-2: HPI-I shall pass the Luhn algorithm check ( (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) ) | ||||||
16. Practitioner.active | |||||||
Definition | Whether this practitioner's record is in active use. | ||||||
Short | Whether this practitioner's record is in active use | ||||||
Comments | If 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. | ||||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||
Fixed Value | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
18. Practitioner.name | |||||||
Definition | The name(s) associated with the practitioner. | ||||||
Short | The name(s) associated with the practitioner | ||||||
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
| ||||||
Control | 10..* | ||||||
Type | HumanName | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
20. Practitioner.name.use | |||||||
Definition | Identifies the purpose for this name. | ||||||
Short | usual | official | temp | nickname | anonymous | old | maiden | ||||||
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from NameUsehttp://hl7.org/fhir/ValueSet/name-use|4.0.1 (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1 )The use of a human name. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
22. Practitioner.name.family | |||||||
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||||
Short | Family name (often called 'Surname') | ||||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||||
Control | 10..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | surname | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
24. Practitioner.name.given | |||||||
Definition | Given name. | ||||||
Short | Given names (not always 'first'). Includes middle names | ||||||
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | first name, middle name | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
26. Practitioner.address | |||||||
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent. | ||||||
Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats)Address(es) of the practitioner that are not role specific (typically home address) | ||||||
Comments | The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address). | ||||||
Control | 0..* This element is affected by the following invariants: ele-1, inv-pra-1 | ||||||
Type | Address(Address, Australian Address) | ||||||
Is Modifier | false | ||||||
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
28. Practitioner.qualification | |||||||
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. | ||||||
Short | Certification, licenses, or training pertaining to the provision of care | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession ( extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists() )inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration ( extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists() )inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display ( issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) ) | ||||||
30. Practitioner.qualification.extension:ahpraProfession-details | |||||||
Slice Name | ahpraProfession-details | ||||||
Definition | An Extension | ||||||
Short | Ahpra Profession Details | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1, inv-pra-0 | ||||||
Type | Extension(Ahpra Profession Details) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
32. Practitioner.qualification.extension:ahpraRegistration-details | |||||||
Slice Name | ahpraRegistration-details | ||||||
Definition | Details on the Ahpra registration of profession. | ||||||
Short | Ahpra Registration Details | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1, inv-pat-1 | ||||||
Type | Extension(Ahpra Registration Details) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
34. Practitioner.qualification.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
36. Practitioner.qualification.code | |||||||
Definition | Coded representation of the qualification. | ||||||
Short | Coded representation of the qualification | ||||||
Control | 1..1 This element is affected by the following invariants: inv-pra-0, inv-pat-1 | ||||||
Binding | The codes SHOULD be taken from For example codes, see hl7VS-degreeLicenseCertificate - AU Extendedhttp://terminology.hl7.org/ValueSet/v2-2.7-0360 (preferred to http://terminology.hl7.org.au/ValueSet/v2-0360-extended ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
38. Practitioner.qualification.issuer | |||||||
Definition | Organization that regulates and issues the qualification. | ||||||
Short | Organization that regulates and issues the qualification | ||||||
Control | 0..1 This element is affected by the following invariants: inv-dh-prac-01 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
Guidance on how to interpret the contents of this table can be found here
0. Practitioner | |||||||
Definition | A person who is directly or indirectly involved in the provisioning of healthcare. | ||||||
Short | A person with a formal responsibility in the provisioning of services | ||||||
Control | 0..* | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty() )dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource ( contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() )dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() )dom-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty() )dom-6: A resource should have narrative for robust management ( text.`div`.exists() )inv-pra-2: Individual gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-genderIdentity').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/gender-identity-response-1')) )inv-pra-3: Individual pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-pronouns').all(extension('value').value.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/australian-pronouns-1')) )inv-pra-4: Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('type').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('type').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-type')) )inv-pra-5: Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('sourceDocument').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('sourceDocument').value.memberOf('http://terminology.hl7.org.au/ValueSet/rsg-document-type')) )inv-pra-6: Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply ( extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').extension('jurisdiction').empty() or extension('http://hl7.org/fhir/StructureDefinition/individual-recordedSexOrGender').all(extension('jurisdiction').value.memberOf('http://terminology.hl7.org.au/ValueSet/jurisdiction-extended')) ) | ||||||
2. Practitioner.id | |||||||
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 | ||||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||||
Control | 0..1 | ||||||
Type | id | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
4. Practitioner.meta | |||||||
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||
Short | Metadata about the resource | ||||||
Control | 0..1 | ||||||
Type | Meta | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
6. Practitioner.implicitRules | |||||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||
Short | A set of rules under which this content was created | ||||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||
Control | 0..1 | ||||||
Type | uri | ||||||
Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
8. Practitioner.language | |||||||
Definition | The base language in which the resource is written. | ||||||
Short | Language of the resource content | ||||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||||
Control | 0..1 | ||||||
Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages )A human language.
| ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
10. Practitioner.text | |||||||
Definition | A human-readable narrative that contains a summary of the resource and can 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 | ||||||
Comments | 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 information is added later. | ||||||
Control | 0..1 | ||||||
Type | Narrative | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | narrative, html, xhtml, display | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
12. Practitioner.contained | |||||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||||
Short | Contained, inline Resources | ||||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||||
Control | 0..* | ||||||
Type | Resource | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | inline resources, anonymous resources, contained resources | ||||||
14. Practitioner.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
Slicing | This element introduces a set of slices on Practitioner.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
16. Practitioner.extension:genderIdentity | |||||||
Slice Name | genderIdentity | ||||||
Definition | An individual's personal sense of being a man, woman, boy, girl, nonbinary, or something else. | ||||||
Short | Gender identity shall be a member of the Gender Identity Response value set if any codes within that value set can apply | ||||||
Comments | Individual Gender identity Gender Identity Response (Extensible). See Australian Bureau of Statics (ABS) Standard for Sex, Gender, Variations of Sex Characteristics and Sexual Orientation Variables, 2020 for further materials. | ||||||
Control | 0..* This element is affected by the following invariants: inv-pra-3 | ||||||
Type | Extension(Individual Gender Identity) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
18. Practitioner.extension:individualPronouns | |||||||
Slice Name | individualPronouns | ||||||
Definition | The pronouns to use when referring to an individual in verbal or written communication. | ||||||
Short | Pronouns shall be a member of the Australian Pronouns value set if any codes within that value set can apply | ||||||
Comments | Individual Pronouns Australian Pronouns (Extensible). | ||||||
Control | 0..* This element is affected by the following invariants: inv-pra-1 | ||||||
Type | Extension(Individual Pronouns) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
20. Practitioner.extension:recordedSexOrGender | |||||||
Slice Name | recordedSexOrGender | ||||||
Definition | A sex or gender property for the individual from a document or other record | ||||||
Short | Recorded sex or gender type shall be a member of the AU Recorded Sex or Gender Type value set if any codes within that value set can apply. Recorded sex or gender source document type shall be a member of the AU Recorded Sex or Gender (RSG) Source Document Type value set if any codes within that value set can apply. Recorded sex or gender jurisdiction shall be a member of the Jurisdiction ValueSet - AU Extended value set if any codes within that value set can apply | ||||||
Comments | Person Recorded Sex Or Gender type AU Recorded Sex or Gender Type (extensible). Person Recorded Sex Or Gender source document AU Recorded Sex or Gender (RSG) Source Document Type (extensible). Person Recorded Sex Or Gender jurisdiction Jurisdiction ValueSet - AU Extended (extensible). | ||||||
Control | 0..* This element is affected by the following invariants: inv-pra-4, inv-pra-5, inv-pra-6 | ||||||
Type | Extension(Person Recorded Sex Or Gender) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
22. Practitioner.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
Summary | false | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
24. Practitioner.identifier | |||||||
Definition | An identifier that applies to this person in this role. | ||||||
Short | An identifier intended for computation | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(Identifier, AU HPI-I, AU PBS Prescriber Number, AU Care Agency Employee Identifier, AU Ahpra Registration Number) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Must Support Types | No must-support rules about the choice of types/profiles | ||||||
Obligations |
| ||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
Slicing | This element introduces a set of slices on Practitioner.identifier . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
26. Practitioner.identifier:hpii | |||||||
Slice Name | hpii | ||||||
Definition | Healthcare Provider Identifier for Individuals (HPI-I) assigned under the HI Service to healthcare providers involved in providing patient care. | ||||||
Short | Healthcare Provider Identifier – Individual (HPI-I) | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(AU HPI-I) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Requirements | Often, specific identities are assigned for the agent. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-hpii-0: HPI-I shall be 16 digits ( value.matches('^([0-9]{16})$') )inv-hpii-1: HPI-I prefix shall be 800361 ( value.startsWith('800361') )inv-hpii-2: HPI-I shall pass the Luhn algorithm check ( (((select(value.substring(0,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(1,1).toInteger())+(select(value.substring(2,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(3,1).toInteger())+(select(value.substring(4,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(5,1).toInteger())+(select(value.substring(6,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(7,1).toInteger())+(select(value.substring(8,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(9,1).toInteger())+(select(value.substring(10,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(11,1).toInteger())+(select(value.substring(12,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(13,1).toInteger())+(select(value.substring(14,1).toInteger()).select(iif($this<5, $this*2, (($this*2)-9))))+(value.substring(15,1).toInteger()))mod 10=0) ) | ||||||
28. Practitioner.active | |||||||
Definition | Whether this practitioner's record is in active use. | ||||||
Short | Whether this practitioner's record is in active use | ||||||
Comments | If 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. | ||||||
Control | 0..1 | ||||||
Type | boolean | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Need to be able to mark a practitioner record as not to be used because it was created in error. | ||||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||
Fixed Value | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
30. Practitioner.name | |||||||
Definition | The name(s) associated with the practitioner. | ||||||
Short | The name(s) associated with the practitioner | ||||||
Comments | The selection of the use property should ensure that there is a single usual name specified, and others use the nickname (alias), old, or other values as appropriate. In general, select the value to be used in the ResourceReference.display based on this:
| ||||||
Control | 1..* | ||||||
Type | HumanName | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Requirements | The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
32. Practitioner.name.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
34. Practitioner.name.extension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can 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 | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Alternate Names | extensions, user content | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
Slicing | This element introduces a set of slices on Practitioner.name.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
36. Practitioner.name.use | |||||||
Definition | Identifies the purpose for this name. | ||||||
Short | usual | official | temp | nickname | anonymous | old | maiden | ||||||
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from NameUse (required to http://hl7.org/fhir/ValueSet/name-use|4.0.1 )The use of a human name. | ||||||
Type | code | ||||||
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
38. Practitioner.name.text | |||||||
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. | ||||||
Short | Text representation of the full name | ||||||
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | A renderable, unencoded form. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
40. Practitioner.name.family | |||||||
Definition | The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. | ||||||
Short | Family name (often called 'Surname') | ||||||
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). | ||||||
Control | 1..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | surname | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
42. Practitioner.name.given | |||||||
Definition | Given name. | ||||||
Short | Given names (not always 'first'). Includes middle names | ||||||
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Must Support | true | ||||||
Obligations |
| ||||||
Summary | true | ||||||
Alternate Names | first name, middle name | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
44. Practitioner.name.prefix | |||||||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. | ||||||
Short | Parts that come before the name | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
46. Practitioner.name.suffix | |||||||
Definition | Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. | ||||||
Short | Parts that come after the name | ||||||
Control | 0..* | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
48. Practitioner.name.period | |||||||
Definition | Indicates the period of time when this name was valid for the named person. | ||||||
Short | Time period when name was/is in use | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Allows names to be placed in historical context. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
50. Practitioner.telecom | |||||||
Definition | A contact detail for the practitioner, e.g. a telephone number or an email address. | ||||||
Short | A contact detail for the practitioner (that apply to all roles) | ||||||
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and to help with identification. These typically will have home numbers, or mobile numbers that are not role specific. | ||||||
Control | 0..* | ||||||
Type | ContactPoint | ||||||
Is Modifier | false | ||||||
Summary | true | ||||||
Requirements | Need to know how to reach a practitioner independent to any roles the practitioner may have. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
52. Practitioner.address | |||||||
Definition | An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. | ||||||
Short | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||||
Comments | The address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). | ||||||
Control | 0..* This element is affected by the following invariants: ele-1, inv-pra-1 | ||||||
Type | Address(Address, Australian Address) | ||||||
Is Modifier | false | ||||||
Requirements | The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
54. Practitioner.gender | |||||||
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. | ||||||
Short | male | female | other | unknown | ||||||
Control | 0..1 | ||||||
Binding | The codes SHALL be taken from AdministrativeGender (required to http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 )The gender of a person used for administrative purposes. | ||||||
Type | code | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Needed to address the person correctly. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
56. Practitioner.birthDate | |||||||
Definition | The date of birth for the practitioner. | ||||||
Short | The date on which the practitioner was born | ||||||
Control | 0..1 | ||||||
Type | date | ||||||
Is Modifier | false | ||||||
Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
Summary | true | ||||||
Requirements | Needed for identification. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
58. Practitioner.photo | |||||||
Definition | Image of the person. | ||||||
Short | Image of the person | ||||||
Control | 0..* | ||||||
Type | Attachment | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
60. Practitioner.qualification | |||||||
Definition | The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality. | ||||||
Short | Certification, licenses, or training pertaining to the provision of care | ||||||
Control | 0..* | ||||||
Type | BackboneElement | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )inv-pra-0: A qualification shall only have Ahpra Profession details if the code is Ahpra Profession ( extension('http://hl7.org.au/fhir/StructureDefinition/ahpraprofession-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRAProfession').exists() )inv-pra-1: A qualification shall only have Ahpra Registration details if the code is Ahpra Registration ( extension('http://hl7.org.au/fhir/StructureDefinition/ahpraregistration-details').exists() implies code.coding.where(system='http://terminology.hl7.org.au/CodeSystem/v2-0360' and code='AUAHPRARegistration').exists() )inv-dh-prac-01: If present, an issuer shall at least have a reference that conforms to ADHA Core Organization, an identifier or a display ( issuer.exists() implies issuer.all(($this.reference.resolve().conformsTo('http://ns.electronichealth.net.au/fhir/StructureDefinition/organization-core-1')) or $this.identifier.exists() or $this.display.exists()) ) | ||||||
62. Practitioner.qualification.id | |||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
Short | Unique id for inter-element referencing | ||||||
Control | 0..1 | ||||||
Type | string | ||||||
Is Modifier | false | ||||||
XML Format | In the XML format, this property is represented as an attribute. | ||||||
Summary | false | ||||||
64. Practitioner.qualification.extension | |||||||
Definition | An Extension | ||||||
Short | Extension | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
Slicing | This element introduces a set of slices on Practitioner.qualification.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
66. Practitioner.qualification.extension:ahpraProfession-details | |||||||
Slice Name | ahpraProfession-details | ||||||
Definition | An Extension | ||||||
Short | Ahpra Profession Details | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1, inv-pra-0 | ||||||
Type | Extension(Ahpra Profession Details) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
68. Practitioner.qualification.extension:ahpraRegistration-details | |||||||
Slice Name | ahpraRegistration-details | ||||||
Definition | Details on the Ahpra registration of profession. | ||||||
Short | Ahpra Registration Details | ||||||
Control | 0..1 This element is affected by the following invariants: ele-1, inv-pat-1 | ||||||
Type | Extension(Ahpra Registration Details) (Complex Extension) | ||||||
Is Modifier | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
70. Practitioner.qualification.modifierExtension | |||||||
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
Short | Extensions that cannot be ignored even if unrecognized | ||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||||
Control | 0..* | ||||||
Type | Extension | ||||||
Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them | ||||||
Summary | true | ||||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
Alternate Names | extensions, user content, modifiers | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) )ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists() ) | ||||||
72. Practitioner.qualification.identifier | |||||||
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. | ||||||
Short | An identifier intended for computation | ||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
Control | 0..* This element is affected by the following invariants: ele-1 | ||||||
Type | Identifier(Identifier, AU Ahpra Registration Number) | ||||||
Is Modifier | false | ||||||
Requirements | Often, specific identities are assigned for the qualification. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
74. Practitioner.qualification.code | |||||||
Definition | Coded representation of the qualification. | ||||||
Short | Coded representation of the qualification | ||||||
Control | 1..1 This element is affected by the following invariants: inv-pra-0, inv-pat-1 | ||||||
Binding | The codes SHOULD be taken from hl7VS-degreeLicenseCertificate - AU Extended (preferred to http://terminology.hl7.org.au/ValueSet/v2-0360-extended ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
76. Practitioner.qualification.period | |||||||
Definition | Period during which the qualification is valid. | ||||||
Short | Period during which the qualification is valid | ||||||
Control | 0..1 | ||||||
Type | Period | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Qualifications are often for a limited period of time, and can be revoked. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
78. Practitioner.qualification.issuer | |||||||
Definition | Organization that regulates and issues the qualification. | ||||||
Short | Organization that regulates and issues the qualification | ||||||
Control | 0..1 This element is affected by the following invariants: inv-dh-prac-01 | ||||||
Type | Reference(Organization) | ||||||
Is Modifier | false | ||||||
Must Support | true | ||||||
Summary | false | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) | ||||||
80. Practitioner.communication | |||||||
Definition | A language the practitioner can use in patient communication. | ||||||
Short | A language the practitioner can use in patient communication | ||||||
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. | ||||||
Control | 0..* | ||||||
Binding | Unless not suitable, these codes SHALL be taken from Common Languages in Australia (extensible to https://healthterminologies.gov.au/fhir/ValueSet/common-languages-australia-2 ) | ||||||
Type | CodeableConcept | ||||||
Is Modifier | false | ||||||
Summary | false | ||||||
Requirements | Knowing which language a practitioner speaks can help in facilitating communication with patients. | ||||||
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |