Schedule - FHIR Resource (r4)


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

Validate an Schedule FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
activefalseboolean# Whether this schedule is in active use
actortrueReference# "actor" : [{ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|
commentfalsestring# Comments on availability
identifiertrueIdentifier# External Ids for this item
planningHorizonfalsePeriod# Period of time covered by schedule
serviceCategorytrueCodeableConcept# High-level category
serviceTypetrueCodeableConcept# Specific service
specialtytrueCodeableConcept# Type of specialty needed

Schedule Example

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

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 }], // High-level category
  "serviceType" : [{ CodeableConcept }], // Specific service
  "specialty" : [{ CodeableConcept }], // Type of specialty needed
  "actor" : [{ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|
   Device|HealthcareService|Location) }], // R!  Resource(s) that availability information is being provided for
  "planningHorizon" : { Period }, // Period of time covered by schedule
  "comment" : "<string>" // Comments on availability
}

Schedule Search Parameters

The following search parameters can be used to query Schedule resources. Just submit them like so:

https://api.1up.health/fhir/r4/Schedule?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
activetextactive
actorreferenceactor
datedateplanningHorizon
identifiertextidentifier
service-categorytextserviceCategory
service-typetextserviceType
specialtytextspecialty