Schedule - FHIR Resource (dstu2)
This Schedule Resource uses the FHIR API standard for access and structure.
Validate an Schedule FHIR Resource (dstu2)
Schedule Attributes
AttributeField is listTypeDescription
Description: Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"comment": Learn more about the (Schedule) comment FHIR attribute
Description: External Ids for this item
FHIR Version: dstu2
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Schedule) identifier FHIR attribute
Description: The period of time that the slots that are attached to 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
FHIR Version: dstu2
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"planningHorizon": Learn more about the (Schedule) planningHorizon FHIR attribute
Description: The schedule type can be used for the categorization of healthcare services or other appointment types
FHIR Version: dstu2
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Schedule) type FHIR attribute
Description: "actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
FHIR Version: dstu2
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actor": Learn more about the (Schedule) actor FHIR attribute
Schedule Structure
{
"resourceType" : "Schedule",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // External Ids for this item
"type" : [{ CodeableConcept }], // The schedule type can be used for the categorization of healthcare services or other appointment types
"actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
HealthcareService|Location) }, // R! The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, Device, Patient or RelatedPerson
"planningHorizon" : { Period }, // The period of time that the slots that are attached to 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 slot(s) that may be associated
}
Schedule Search Parameters
The following search parameters can be used to query Schedule resources. Just submit them like so:
https://api.1up.health/fhir/dstu2/Schedule?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
actor | reference | actor |
date | date | planningHorizon |
identifier | text | identifier |
type | text | type |
