Skip to content

Appointment Profile

Canonical../StructureDefinition/nexus-emr-core-appointment
Statusdraft · 1.26.0
BaseAppointment (constraint)
SourceFSH · JSON

Minimal Nexus EMR profile for Appointment resources, primarily for mapping status, start date (Last Visit Date), and required patient/practitioner participants. Assumes filtering for status='fulfilled' happens during data retrieval/processing. Contains embedded aliases and invariants.

Examples

With Slot Linkage · Example · Example telephone · Walk-in

With Slot Linkage

Example Appointment booked from a free Slot — demonstrates the new Appointment.slot reference wired in 1.10.0

Appointment/nexus-emr-core-appointment-example-with-slot — claims conformance to Appointment Profile

{
  "resourceType": "Appointment",
  "id": "nexus-emr-core-appointment-example-with-slot",
  "meta": {
    "profile": [
      "../StructureDefinition/nexus-emr-core-appointment"
    ]
  },
  "extension": [
    {
      "url": "../StructureDefinition/nexus-emr-appointment-created-by-extension",
      "valueReference": {
        "reference": "PractitionerRole/dr-navarro-familymed-role",
        "display": "Dr. Emil Navarro — Family Medicine"
      }
    }
  ],
  "identifier": [
    {
      "system": "../NamingSystem/cedarbrook-clinic-appointment-raw-code",
      "value": "oscar-appt-99821",
      "use": "secondary"
    }
  ],
  "status": "booked",
  "created": "2026-05-28T14:30:00-04:00",
  "start": "2026-06-01T10:00:00-04:00",
  "end": "2026-06-01T10:15:00-04:00",
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'>Booked appointment for Avery Linwood with Dr. Navarro on June 1 2026 at 10:00 AM. Created from the booked Slot (nexus-emr-core-slot-example-busy) via the FHIR booking flow.</div>"
  },
  "slot": [
    {
      "reference": "Slot/nexus-emr-core-slot-example-busy"
    }
  ],
  "serviceType": [
    {
      "coding": [
        {
          "system": "../NamingSystem/cedarbrook-clinic-appointment-servicetype-raw-code",
          "code": "A",
          "display": "Standard appointment"
        }
      ]
    }
  ],
  "appointmentType": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
        "code": "ROUTINE",
        "display": "Routine appointment - default if not valued"
      }
    ]
  },
  "participant": [
    {
      "actor": {
        "reference": "Location/cedarbrook-site-a",
        "display": "Cedarbrook Family Health Site A"
      },
      "status": "accepted"
    },
    {
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "PART",
              "display": "Participation"
            }
          ]
        }
      ],
      "actor": {
        "reference": "Patient/avery-linwood",
        "display": "Avery Linwood"
      },
      "status": "accepted"
    },
    {
      "type": [
        {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "PPRF",
              "display": "primary performer"
            }
          ]
        }
      ],
      "actor": {
        "reference": "PractitionerRole/dr-navarro-familymed-role",
        "display": "Dr. Emil Navarro — Family Medicine"
      },
      "status": "accepted"
    }
  ]
}

Referenced by: Booking Confirmed by the Patient