practitioner roles

Create Practitioner Role

post

/organizations/{organizationId}/fhir/4/PractitionerRole

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a PractitionerRole resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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).
identifier	array(Identifier)	Business Identifiers that are specific to a role/location.
active	boolean	Whether this practitioner role record is in active use.
period	Period	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitioner	Reference	Practitioner that is able to provide the defined services for the organization.
organization	Reference	The organization where the Practitioner performs the roles associated.
code	array(CodeableConcept)	Roles which this practitioner is authorized to perform for the organization.
specialty	array(CodeableConcept)	Specific specialty of the practitioner.
location	array(Reference)	The location(s) at which this practitioner provides care.
healthcareService	array(Reference)	The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecom	array(ContactPoint)	Contact details that are specific to the role/location/service.
availableTime	array(PractitionerRole_AvailableTime)	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailable	array(PractitionerRole_NotAvailable)	The practitioner is not available or performing this role during this period of time due to the provided reason.
availabilityExceptions	string	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.
endpoint	array(Reference)	Technical endpoints providing access to services operated for the practitioner with this role.

Response

201 400 401 404

Patch Practitioner Role

patch

/organizations/{organizationId}/fhir/4/PractitionerRole/{resourceId}

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Nictiz profile: PractitionerRole

Request

Headers

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a PractitionerRole resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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).
identifier	array(Identifier)	Business Identifiers that are specific to a role/location.
active	boolean	Whether this practitioner role record is in active use.
period	Period	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitioner	Reference	Practitioner that is able to provide the defined services for the organization.
organization	Reference	The organization where the Practitioner performs the roles associated.
code	array(CodeableConcept)	Roles which this practitioner is authorized to perform for the organization.
specialty	array(CodeableConcept)	Specific specialty of the practitioner.
location	array(Reference)	The location(s) at which this practitioner provides care.
healthcareService	array(Reference)	The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecom	array(ContactPoint)	Contact details that are specific to the role/location/service.
availableTime	array(PractitionerRole_AvailableTime)	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailable	array(PractitionerRole_NotAvailable)	The practitioner is not available or performing this role during this period of time due to the provided reason.
availabilityExceptions	string	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.
endpoint	array(Reference)	Technical endpoints providing access to services operated for the practitioner with this role.

Response

200 201 400 401 404 409

Read Practitioner Role

get

/organizations/{organizationId}/fhir/4/PractitionerRole/{resourceId}

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Practitioner Role

get

/organizations/{organizationId}/fhir/4/PractitionerRole/{resourceId}/_history

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Practitioner Role

get

/organizations/{organizationId}/fhir/4/PractitionerRole/{resourceId}/_history/{versionId}

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Practitioner Role

delete

/organizations/{organizationId}/fhir/4/PractitionerRole/{resourceId}

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Practitioner Role

get

/organizations/{organizationId}/fhir/4/PractitionerRole

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Practitioner Role

get

/organizations/{organizationId}/fhir/4/PractitionerRole/_history

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search Post Practitioner Role

post

/organizations/{organizationId}/fhir/4/PractitionerRole/_search

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a PractitionerRole resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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).
identifier	array(Identifier)	Business Identifiers that are specific to a role/location.
active	boolean	Whether this practitioner role record is in active use.
period	Period	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitioner	Reference	Practitioner that is able to provide the defined services for the organization.
organization	Reference	The organization where the Practitioner performs the roles associated.
code	array(CodeableConcept)	Roles which this practitioner is authorized to perform for the organization.
specialty	array(CodeableConcept)	Specific specialty of the practitioner.
location	array(Reference)	The location(s) at which this practitioner provides care.
healthcareService	array(Reference)	The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecom	array(ContactPoint)	Contact details that are specific to the role/location/service.
availableTime	array(PractitionerRole_AvailableTime)	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailable	array(PractitionerRole_NotAvailable)	The practitioner is not available or performing this role during this period of time due to the provided reason.
availabilityExceptions	string	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.
endpoint	array(Reference)	Technical endpoints providing access to services operated for the practitioner with this role.

Response

200 401 404

Update Practitioner Role

put

/organizations/{organizationId}/fhir/4/PractitionerRole/{resourceId}

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

Nictiz profile: PractitionerRole

Request

Headers


accept	string
content-type*	string	application/json\|application/xml\|application/fhir+json\|application/fhir+xml	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a PractitionerRole resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	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.
implicitRules	uri	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.
language	code	The base language in which the resource is written.
text	Narrative	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	array(ResourceList)	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.
extension	array(Extension)	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.
modifierExtension	array(Extension)	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).
identifier	array(Identifier)	Business Identifiers that are specific to a role/location.
active	boolean	Whether this practitioner role record is in active use.
period	Period	The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
practitioner	Reference	Practitioner that is able to provide the defined services for the organization.
organization	Reference	The organization where the Practitioner performs the roles associated.
code	array(CodeableConcept)	Roles which this practitioner is authorized to perform for the organization.
specialty	array(CodeableConcept)	Specific specialty of the practitioner.
location	array(Reference)	The location(s) at which this practitioner provides care.
healthcareService	array(Reference)	The list of healthcare services that this worker provides for this role's Organization/Location(s).
telecom	array(ContactPoint)	Contact details that are specific to the role/location/service.
availableTime	array(PractitionerRole_AvailableTime)	A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
notAvailable	array(PractitionerRole_NotAvailable)	The practitioner is not available or performing this role during this period of time due to the provided reason.
availabilityExceptions	string	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.
endpoint	array(Reference)	Technical endpoints providing access to services operated for the practitioner with this role.

Response

200 201 400 401 404 409