schedules

Create Schedule

post

/organizations/{organizationId}/fhir/4/Schedule

A container for slots of time that may be available for booking appointments.

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule 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)	External Ids for this item.
active	boolean	Whether this schedule record is in active use or should not be used (such as was entered in error).
serviceCategory	array(CodeableConcept)	A broad categorization of the service that is to be performed during this appointment.
serviceType	array(CodeableConcept)	The specific service that is to be performed during this appointment.
specialty	array(CodeableConcept)	The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*	array(Reference)	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
planningHorizon	Period	The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
comment	string	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

201 400 401 404

Patch Schedule

patch

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

A container for slots of time that may be available for booking appointments.

Request

Headers


content-type*	string	application/json-patch+json	application/json-patch+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 Schedule 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)	External Ids for this item.
active	boolean	Whether this schedule record is in active use or should not be used (such as was entered in error).
serviceCategory	array(CodeableConcept)	A broad categorization of the service that is to be performed during this appointment.
serviceType	array(CodeableConcept)	The specific service that is to be performed during this appointment.
specialty	array(CodeableConcept)	The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*	array(Reference)	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
planningHorizon	Period	The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
comment	string	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

200 201 400 401 404 409

Read Schedule

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule

get

/organizations/{organizationId}/fhir/4/Schedule

Request

Headers


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

Query params


_id	string
_language	string
active	string
actor	string
date	string
identifier	string
service-category	string
specialty	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Schedule

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule

post

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

A container for slots of time that may be available for booking appointments.

Request

Headers


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

Query params


_id	string
_language	string
active	string
actor	string
date	string
identifier	string
service-category	string
specialty	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a Schedule 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)	External Ids for this item.
active	boolean	Whether this schedule record is in active use or should not be used (such as was entered in error).
serviceCategory	array(CodeableConcept)	A broad categorization of the service that is to be performed during this appointment.
serviceType	array(CodeableConcept)	The specific service that is to be performed during this appointment.
specialty	array(CodeableConcept)	The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*	array(Reference)	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
planningHorizon	Period	The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
comment	string	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

200 401 404

Update Schedule

put

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

A container for slots of time that may be available for booking appointments.

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 Schedule 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)	External Ids for this item.
active	boolean	Whether this schedule record is in active use or should not be used (such as was entered in error).
serviceCategory	array(CodeableConcept)	A broad categorization of the service that is to be performed during this appointment.
serviceType	array(CodeableConcept)	The specific service that is to be performed during this appointment.
specialty	array(CodeableConcept)	The specialty of a practitioner that would be required to perform the service requested in this appointment.
actor*	array(Reference)	Slots that reference this schedule resource provide the availability details to these referenced resource(s).
planningHorizon	Period	The period of time that the slots that reference this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates.
comment	string	Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated.

Response

200 201 400 401 404 409