Schedule - FHIR Resource (dstu2)


This Schedule Resource uses the FHIR API standard for access and structure.

Validate an Schedule FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
actorfalseReference "actor" : { Reference(Patient|Practitioner|RelatedPerson|Device|
commentfalsestring Comments on the availability to describe any extended information. Such as custom constraints on the slot(s) that may be associated
identifiertrueIdentifier External Ids for this item
planningHorizonfalsePeriod 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
typetrueCodeableConcept The schedule type can be used for the categorization of healthcare services or other appointment types

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 the like so:

https://api.1up.health/fhir/dstu2/Schedule?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actorreferenceactor
datedateplanningHorizon
identifiertextidentifier
typetexttype