Schedule - FHIR Resource (r4)

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

Validate an Schedule FHIR Resource (r4)

Schedule Attributes

AttributeField is listTypeDescription

Description: External Ids for this item

FHIR Version: r4

Attribute Type : Identifier

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"identifier": [
  {
    "use": "usual",
    "system": "http://example.org/scheduleid",
    "value": "45"
  }
]

Learn more about the (Schedule) identifier FHIR attribute

Description: Whether this schedule is in active use

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"active": true

Learn more about the (Schedule) active FHIR attribute

Description: High-level category

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"serviceCategory": [
  {
    "coding": [
      {
        "code": "17",
        "display": "General Practice"
      }
    ]
  }
]

Learn more about the (Schedule) serviceCategory FHIR attribute

Description: Specific service

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"serviceType": [
  {
    "coding": [
      {
        "code": "57",
        "display": "Immunization"
      }
    ]
  }
]

Learn more about the (Schedule) serviceType FHIR attribute

Description: Type of specialty needed

FHIR Version: r4

Attribute Type : CodeableConcept

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"specialty": [
  {
    "coding": [
      {
        "code": "408480009",
        "display": "Clinical immunology"
      }
    ]
  }
]

Learn more about the (Schedule) specialty FHIR attribute

Description: "actor" : [{ Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"actor": [
  {
    "reference": "Location/1",
    "display": "Burgers UMC, South Wing, second floor"
  }
]

Learn more about the (Schedule) actor FHIR attribute

Description: Period of time covered by schedule

FHIR Version: r4

Attribute Type : Period

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"planningHorizon": {
  "start": "2013-12-25T09:15:00Z",
  "end": "2013-12-25T09:30:00Z"
}

Learn more about the (Schedule) planningHorizon FHIR attribute

Description: Comments on availability

FHIR Version: r4

Attribute Type : string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"comment": "The slots attached to this schedule should be specialized to cover immunizations within the clinic"

Learn more about the (Schedule) comment FHIR attribute

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 Parameter	Field Type	Resource Fields Searched
`active`	`text`	`active`
`actor`	`reference`	`actor`
`date`	`date`	`planningHorizon`
`identifier`	`text`	`identifier`
`service-category`	`text`	`serviceCategory`
`service-type`	`text`	`serviceType`
`specialty`	`text`	`specialty`