Generated Narrative: StructureDefinition dh-practitionerrole-author-cae-mhr-1 Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> <a href="StructureDefinition-dh-practitionerrole-author-cae-mhr-1-definitions.html#PractitionerRole" title="A care agency employee acting as an author or observer, on behalf of an organisation. A care agency employee is a person appointed by a care agency to manage the care of one or more Individuals. The person may work under::#xA;#xA;* an employment contract with a federal, state or territory government Care Agency:#xA;#xA;* an employment contract with a subcontracted Care Agency or:#xA;#xA;* a volunteer arrangement where the person acts as if they are an employee of a Care Agency, but not including relatives or adoptive parents.">PractitionerRole 0..* MHRPractitionerRoleAuthoring A care agency employee acting as an author or observer, on behalf of an organisation #xD; Slices for identifier Content/Rules for all slices #xD; identifier:caei S 1..1 AUCareAgencyEmployeeIdentifier Business Identifiers that are specific to a role/location #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
The purpose of this profile is to define a representation of a care agency employee (practitioner) acting as an author or observer, on behalf of an organisation, for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.
A care agency employee acting as an author or observer, on behalf of an organisation
A care agency employee acting as an author or observer, on behalf of an organisation. A care agency employee is a person appointed by a care agency to manage the care of one or more Individuals. The person may work under:: * an employment contract with a federal, state or territory government Care Agency: * an employment contract with a subcontracted Care Agency or: * a volunteer arrangement where the person acts as if they are an employee of a Care Agency, but not including relatives or adoptive parents.
A care agency is a government agency, or an organisation approved by the appropriate government agency, responsible for managing the care of individuals. In the context of the My Health Record, a care agency employee may manage a child's My Health Record as an authorised representative.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
If present, an organization shall at least have a reference, an identifier or a display
organization.exists() implies organization.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
not(exists(f:organization)) or exists(f:organization/f:reference) or exists(f:organization/f:identifier) or exists(f:organization/f:display)
If present, a location shall at least have a reference, an identifier or a display
location.exists() implies location.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
not(exists(f:location)) or exists(f:location/f:reference) or exists(f:location/f:identifier) or exists(f:location/f:display)
If present, a healthcare service shall at least have a reference, an identifier or a display
healthcareService.exists() implies healthcareService.all($this.reference.exists() or $this.identifier.exists() or $this.display.exists())
not(exists(f:healthcareService)) or exists(f:healthcareService/f:reference) or exists(f:healthcareService/f:identifier) or exists(f:healthcareService/f:display)
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
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.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
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.
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.
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
The base language in which the resource is written.
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).
Text summary of the resource, for human interpretation
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.
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.
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.
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.
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. 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.
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.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
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).
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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Business Identifiers that are specific to a role/location
Business Identifiers that are specific to a role/location.
Often, specific identities are assigned for the agent.
Whether this practitioner role record is in active use
Whether this practitioner role record is in active use.
If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active.
Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use.
This resource is generally assumed to be active if no value is provided for the active element
The period during which the practitioner is authorized to perform in these role(s)
The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
Even after the agencies is revoked, the fact that it existed must still be recorded.
.performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime
(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
Practitioner that is able to provide the defined services for the organization
Practitioner that is able to provide the defined services for the organization.
At least a reference, identifier or display shall be present, or, if neither is available, the Data Absent Reason extension shall be present
(reference.exists() or identifier.exists() or display.exists()) xor extension('http://hl7.org/fhir/StructureDefinition/data-absent-reason').exists()
(exists(f:reference) or exists(f:display) or exists(f:identifier)) and not(exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])) or not(exists(f:reference) or exists(f:display) or exists(f:identifier)) and exists(f:extension[@url='http://hl7.org/fhir/StructureDefinition/data-absent-reason'])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
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.
Literal reference, Relative, internal or absolute URL
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.
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.
Type the reference refers to (e.g. "Patient")
The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
Aa resource (or, for logical models, the URI of the logical model).
Logical reference, when literal reference is not known
An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.
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. When 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 Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
Plain text narrative that identifies the resource in addition to the resource reference.
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.
Organization where the roles are available
The organization where the Practitioner performs the roles associated.
Roles which this practitioner may perform
Roles which this practitioner is authorized to perform for the organization.
Need to know what authority the practitioner has - what can they do?
.player.HealthCareProvider[@classCode = 'PROV'].code
The location(s) at which this practitioner provides care
The location(s) at which this practitioner provides care.
.performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC']
(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)
The list of healthcare services that this worker provides for this role's Organization/Location(s)
The list of healthcare services that this worker provides for this role's Organization/Location(s).
.player.QualifiedEntity[@classCode = 'QUAL'].code
Contact details that are specific to the role/location/service
Contact details that are specific to the role/location/service.
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.
A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
More detailed availability information may be provided in associated Schedule/Slot resources.
Extensions that cannot be ignored even if unrecognized
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).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Indicates which days of the week are available between the start and end Times.
Is this always available? (hence times are irrelevant) e.g. 24 hour service.
Opening time of day (ignored if allDay = true)
The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
The timezone is expected to be for where this HealthcareService is provided at.
unique id for the element within a resource (for internal references)
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Closing time of day (ignored if allDay = true)
The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
Not available during this time due to provided reason
The practitioner is not available or performing this role during this period of time due to the provided reason.
Reason presented to the user explaining why time not available
The reason that can be presented to the user as to why this time is not available.
Service is not available (seasonally or for a public holiday) from this date.
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.
Technical endpoints providing access to services operated for the practitioner with this role
Technical endpoints providing access to services operated for the practitioner with this role.
Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose.