US Core Implementation Guide
10.0.0-ballot - STU 10 Ballot United States of America flag

US Core Implementation Guide, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 10.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/US-Core/ and changes regularly. See the Directory of published versions

: Booked Future Appointment Example - JSON Representation

Page standards status: Informative

Raw json | Download

{
  "resourceType" : "Appointment",
  "id" : "booked-physical",
  "meta" : {
    "profile" : [
      🔗 "http://hl7.org/fhir/us/core/StructureDefinition/us-core-appointment|10.0.0-ballot"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: Appointment booked-physical</b></p><a name=\"booked-physical\"> </a><a name=\"hcbooked-physical\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-us-core-appointment.html\">US Core Appointment Profile</a> version: 10.0.0-ballot</p></div><p><b>identifier</b>: <code>http://example.org/appointment/identifiers</code>/appt-2026-0915-001</p><p><b>status</b>: Booked</p><p><b>serviceType</b>: <span title=\"Codes:{http://snomed.info/sct 185349003}\">Annual Physical Exam</span></p><p><b>start</b>: 2026-09-15 14:00:00+0000</p><p><b>end</b>: 2026-09-15 14:30:00+0000</p><blockquote><p><b>participant</b></p><p><b>actor</b>: <a href=\"Patient-example.html\">Amy V. Baxter  (no stated gender), DoB: 1987-02-20 ( Medical Record Number:\u00a01032702\u00a0(use:\u00a0usual))</a></p><p><b>required</b>: Required</p><p><b>status</b>: Accepted</p></blockquote><blockquote><p><b>participant</b></p><p><b>type</b>: <span title=\"Codes:{http://terminology.hl7.org/CodeSystem/v3-ParticipationType PPRF}\">primary performer</span></p><p><b>actor</b>: <a href=\"Practitioner-practitioner-1.html\">Dr Ronald Bone</a></p><p><b>required</b>: Required</p><p><b>status</b>: Accepted</p></blockquote><blockquote><p><b>participant</b></p><p><b>actor</b>: <a href=\"Location-hospital.html\">Holy Family Hospital</a></p><p><b>required</b>: Required</p><p><b>status</b>: Accepted</p></blockquote></div>"
  },
  "identifier" : [
    {
      "system" : "http://example.org/appointment/identifiers",
      "value" : "appt-2026-0915-001"
    }
  ],
  "status" : "booked",
  "serviceType" : [
    {
      "coding" : [
        {
          "system" : "http://snomed.info/sct",
          "version" : "http://snomed.info/sct/731000124108",
          "code" : "185349003",
          "display" : "Encounter for check up"
        }
      ],
      "text" : "Annual Physical Exam"
    }
  ],
  "start" : "2026-09-15T14:00:00Z",
  "end" : "2026-09-15T14:30:00Z",
  "participant" : [
    {
      "actor" : {
        🔗 "reference" : "Patient/example"
      },
      "required" : "required",
      "status" : "accepted"
    },
    {
      "type" : [
        {
          "coding" : [
            {
              "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code" : "PPRF",
              "display" : "primary performer"
            }
          ]
        }
      ],
      "actor" : {
        🔗 "reference" : "Practitioner/practitioner-1",
        "display" : "Dr Ronald Bone"
      },
      "required" : "required",
      "status" : "accepted"
    },
    {
      "actor" : {
        🔗 "reference" : "Location/hospital",
        "display" : "Holy Family Hospital"
      },
      "required" : "required",
      "status" : "accepted"
    }
  ]
}