Release 5 Preview #2
AdministrationThis page is part of the FHIR Specification (v4.4.0: R5 Preview #2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Patient Administration Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Practitioner |
This is a representation of the json schema for PractitionerRole, which is just a part of the full JSON Schema.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/PractitionerRole",
"$ref": "#/definitions/PractitionerRole",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"PractitionerRole": {
"description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
"properties": {
"resourceType": {
"description": "This is a PractitionerRole resource",
"const": "PractitionerRole"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "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.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "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.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "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.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "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.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "Business Identifiers that are specific to a role/location.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"active": {
"description": "Whether this practitioner role record is in active use.",
"$ref": "#/definitions/boolean"
},
"_active": {
"description": "Extensions for active",
"$ref": "Element.schema.json#/definitions/Element"
},
"period": {
"description": "The period during which the person is authorized to act as a practitioner in these role(s) for the organization.",
"$ref": "Period.schema.json#/definitions/Period"
},
"practitioner": {
"description": "Practitioner that is able to provide the defined services for the organization.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"organization": {
"description": "The organization where the Practitioner performs the roles associated.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"code": {
"description": "Roles which this practitioner is authorized to perform for the organization.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"specialty": {
"description": "Specific specialty of the practitioner.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"location": {
"description": "The location(s) at which this practitioner provides care.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"healthcareService": {
"description": "The list of healthcare services that this worker provides for this role\u0027s Organization/Location(s).",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
},
"telecom": {
"description": "Contact details that are specific to the role/location/service.",
"items": {
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"type": "array"
},
"availableTime": {
"description": "A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.",
"items": {
"$ref": "#/definitions/PractitionerRole_AvailableTime"
},
"type": "array"
},
"notAvailable": {
"description": "The practitioner is not available or performing this role during this period of time due to the provided reason.",
"items": {
"$ref": "#/definitions/PractitionerRole_NotAvailable"
},
"type": "array"
},
"availabilityExceptions": {
"description": "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.",
"$ref": "#/definitions/string"
},
"_availabilityExceptions": {
"description": "Extensions for availabilityExceptions",
"$ref": "Element.schema.json#/definitions/Element"
},
"endpoint": {
"description": "Technical endpoints providing access to services operated for the practitioner with this role.",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"PractitionerRole_AvailableTime": {
"description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"daysOfWeek": {
"description": "Indicates which days of the week are available between the start and end Times.",
"items": {
"$ref": "#/definitions/code"
},
"type": "array"
},
"_daysOfWeek": {
"description": "Extensions for daysOfWeek",
"items": {
"$ref": "Element.schema.json#/definitions/Element"
},
"type": "array"
},
"allDay": {
"description": "Is this always available? (hence times are irrelevant) e.g. 24 hour service.",
"$ref": "#/definitions/boolean"
},
"_allDay": {
"description": "Extensions for allDay",
"$ref": "Element.schema.json#/definitions/Element"
},
"availableStartTime": {
"description": "The opening time of day. Note: If the AllDay flag is set, then this time is ignored.",
"$ref": "#/definitions/time"
},
"_availableStartTime": {
"description": "Extensions for availableStartTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"availableEndTime": {
"description": "The closing time of day. Note: If the AllDay flag is set, then this time is ignored.",
"$ref": "#/definitions/time"
},
"_availableEndTime": {
"description": "Extensions for availableEndTime",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"additionalProperties": false
},
"PractitionerRole_NotAvailable": {
"description": "A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "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.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "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\u0027s 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"description": {
"description": "The reason that can be presented to the user as to why this time is not available.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"during": {
"description": "Service is not available (seasonally or for a public holiday) from this date.",
"$ref": "Period.schema.json#/definitions/Period"
}
},
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR CI Build hl7.fhir.core#4.4.0 generated on Sun, May 3, 2020 08:47+1000.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change