Schedule - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
activefalseboolean Whether this schedule is in active use
actortrueReference "actor" : [{ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|
commentfalsestring Comments on the availability to describe any extended information. Such as custom constraints on the slots 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
serviceCategoryfalseCodeableConcept A broad categorisation of the service that is to be performed during this appointment
serviceTypetrueCodeableConcept The specific service that is to be performed during this appointment
specialtytrueCodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment

Schedule Example

{
  "comment": "The slots attached to this schedule should be specialized to cover immunizations within the clinic",
  "serviceCategory": {
    "coding": [
      {
        "code": "17",
        "display": "General Practice"
      }
    ]
  },
  "resourceType": "Schedule",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      Burgers UMC, South Wing, second floor Physiotherapy Schedule\n    </div>"
  },
  "serviceType": [
    {
      "coding": [
        {
          "code": "57",
          "display": "Immunization"
        }
      ]
    }
  ],
  "actor": [
    {
      "display": "Burgers UMC, South Wing, second floor",
      "reference": "Location/1"
    }
  ],
  "specialty": [
    {
      "coding": [
        {
          "code": "408480009",
          "display": "Clinical immunology"
        }
      ]
    }
  ],
  "planningHorizon": {
    "start": "2013-12-25T09:15:00Z",
    "end": "2013-12-25T09:30:00Z"
  },
  "active": true,
  "identifier": [
    {
      "use": "usual",
      "system": "http://example.org/scheduleid",
      "value": "45"
    }
  ],
  "id": "example"
}

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
  "active" : <boolean>, // Whether this schedule is in active use
  "serviceCategory" : { CodeableConcept }, // A broad categorisation of the service that is to be performed during this appointment
  "serviceType" : [{ CodeableConcept }], // The specific service that is to be performed during this appointment
  "specialty" : [{ CodeableConcept }], // The specialty of a practitioner that would be required to perform the service requested in this appointment
  "actor" : [{ Reference(Patient|Practitioner|PractitionerRole|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, PractitionerRole, 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 slots 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/stu3/Schedule?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
actorreferenceactor
datedateplanningHorizon
identifiertextidentifier
typetextserviceType