# US Core Appointment Profile - Health eData 1 Sandbox v0.1.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **US Core Appointment Profile**

## Resource Profile: US Core Appointment Profile 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/core/StructureDefinition/us-core-appointment | *Version*:0.1.0 | |
| Active as of 2026-05-06 | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 3 | *Computable Name*:USCoreAppointmentProfile |
| *Other Identifiers:*OID:2.16.840.1.113883.4.642.40.2.42.69 | | |

 
The US Core Appointment Profile inherits from the FHIR [Appointment](https://hl7.org/fhir/R4/appointment.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) **Appointment Data Element of the Encounter Information Data Class**. It sets minimum expectations for the Appointment resource to record, search, and fetch information about a healthcare event scheduled for a past, current, or future date and time. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. 

**Example Usage Scenarios:**

The following are example usage scenarios for the US Core Appointment profile:

* Query for Appointment resources belonging to a Patient
* [Record or update] a Patient Appointment

### Mandatory and Must Support Data Elements

The following data elements must always be present ([Mandatory] definition) or must be supported if the data is present in the sending system ([Must Support] definition). They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The [Formal Views] below provides the formal summary, definitions, and terminology requirements.

**Each Appointment Must Have:**

1. a status
1. a participant (person, location/healthcare service or device)

**Each Appointment Must Support:**

1. external identifiers for this appointment
1. the specific service to be performed during the appointment
1. when the appointment starts
1. when the appointment ends
1. a patient participant involved in the appointment

### Profile Specific Implementation Guidance

This section provides detailed implementation guidance for the US Core Profile to support implementation and certification.

### Liquid Script to Generate StructureDefinition All Nice N Pretty Like

{% include structure-table.md sd=sd source="differential" show_must_support=true show_uscdi=true %}

## USCoreAppointmentProfile — US Core Appointment Profile

The US Core Appointment Profile inherits from the FHIR [Appointment](https://hl7.org/fhir/R4/appointment.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) **Appointment Data Element of the Encounter Information Data Class**. It sets minimum expectations for the Appointment resource to record, search, and fetch information about a healthcare event scheduled for a past, current, or future date and time. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

* **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-appointment`
* **Version:** 0.1.0
* **Status:** active
* **Kind:** resource
* **Type:** `Appointment`
* **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Appointment`
* **Derivation:** constraint

### Elements (differential)

| | | | | | |
| :--- | :--- | :--- | :--- | :--- | :--- |
| `Appointment` |   |   | 0..* |   | **A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)**A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| ↳`identifier` | ✅ |   | 0..* | `Identifier` | **External Ids for this item**This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
| ↳`status` | ✅ |   | 1..1 | `code` | **proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error | checked-in | waitlist**The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.**Binding:** `http://hl7.org/fhir/ValueSet/appointmentstatus` (required) |
| ↳`serviceType` | ✅ |   | 0..* | `CodeableConcept` | **The specific service that is to be performed during this appointment**The specific service that is to be performed during this appointment.**Binding:** `https://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-services` (example) — Value Sets are typically bound to local service catalogs, and mapping to standard vocabularies can not be expected. |
| ↳`start` | ✅ |   | 0..1 | `instant` | **When appointment is to take place**Date/Time that the appointment is to take place. |
| ↳`end` | ✅ |   | 0..1 | `instant` | **When appointment is to conclude**Date/Time that the appointment is to conclude. |
| ↳`participant` | ✅ |   | 1..* | `BackboneElement` | **Participants involved in appointment**List of participants involved in the appointment. |
| ↳`type` |   |   | 0..* | `CodeableConcept` | **Role of participant in the appointment**Role of participant in the appointment.**Binding:** `http://hl7.org/fhir/ValueSet/encounter-participant-type` (extensible) |
| ↳`actor` | ✅ |   | 1..1 | `Reference`target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patienttarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionertarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerroletarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedpersontarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-devicetarget: http://hl7.org/fhir/StructureDefinition/HealthcareServicetarget: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location | **Person, Location/HealthcareService or Device**A Person, Location/HealthcareService or Device that is participating in the appointment. |
| ↳`status` | ✅ |   | 1..1 | `code` | **accepted | declined | tentative | needs-action**Participation status of the actor.**Binding:** `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` (required) — The Participation status of an appointment. |

```


## USCoreAppointmentProfile — US Core Appointment Profile

The US Core Appointment Profile inherits from the FHIR [Appointment](https://hl7.org/fhir/R4/appointment.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Appointment Data Element of the Encounter Information Data Class*. It sets minimum expectations for the Appointment resource to record, search, and fetch information about a healthcare event scheduled for a past, current, or future date and time. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.

- **URL:** `http://hl7.org/fhir/us/core/StructureDefinition/us-core-appointment`
- **Version:** 0.1.0
- **Status:** active
- **Kind:** resource
- **Type:** `Appointment`
- **Base Definition:** `http://hl7.org/fhir/StructureDefinition/Appointment`
- **Derivation:** constraint


### Elements (differential)

| Element | Must Support | Add'l USCDI | Cardinality | Type | Description |
|---|:---:|:---:|---|---|---|
| `Appointment` |  |  | 0..* |  | **A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)**<br/>A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s). |
| <span style="padding-left: 1.5em;">↳</span> `identifier` | ✅ |  | 0..* | `Identifier` | **External Ids for this item**<br/>This records identifiers associated with this appointment concern that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation). |
| <span style="padding-left: 1.5em;">↳</span> `status` | ✅ |  | 1..1 | `code` | **proposed \| pending \| booked \| arrived \| fulfilled \| cancelled \| noshow \| entered-in-error \| checked-in \| waitlist**<br/>The overall status of the Appointment. Each of the participants has their own participation status which indicates their involvement in the process, however this status indicates the shared status.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/appointmentstatus` (required)</span> |
| <span style="padding-left: 1.5em;">↳</span> `serviceType` | ✅ |  | 0..* | `CodeableConcept` | **The specific service that is to be performed during this appointment**<br/>The specific service that is to be performed during this appointment.<br/><span style="font-size: 0.85em;">**Binding:** `https://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-services` (example) — Value Sets are typically bound to local service catalogs, and mapping to standard vocabularies can not be expected.</span> |
| <span style="padding-left: 1.5em;">↳</span> `start` | ✅ |  | 0..1 | `instant` | **When appointment is to take place**<br/>Date/Time that the appointment is to take place. |
| <span style="padding-left: 1.5em;">↳</span> `end` | ✅ |  | 0..1 | `instant` | **When appointment is to conclude**<br/>Date/Time that the appointment is to conclude. |
| <span style="padding-left: 1.5em;">↳</span> `participant` | ✅ |  | 1..* | `BackboneElement` | **Participants involved in appointment**<br/>List of participants involved in the appointment. |
| <span style="padding-left: 3.0em;">↳</span> `type` |  |  | 0..* | `CodeableConcept` | **Role of participant in the appointment**<br/>Role of participant in the appointment.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/encounter-participant-type` (extensible)</span> |
| <span style="padding-left: 3.0em;">↳</span> `actor` | ✅ |  | 1..1 | `Reference`<br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-device</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/StructureDefinition/HealthcareService</span><br/><span style="font-size: 0.85em;">target: http://hl7.org/fhir/us/core/StructureDefinition/us-core-location</span> | **Person, Location/HealthcareService or Device**<br/>A Person, Location/HealthcareService or Device that is participating in the appointment. |
| <span style="padding-left: 3.0em;">↳</span> `status` | ✅ |  | 1..1 | `code` | **accepted \| declined \| tentative \| needs-action**<br/>Participation status of the actor.<br/><span style="font-size: 0.85em;">**Binding:** `http://hl7.org/fhir/ValueSet/participationstatus\|4.0.1` (required) — The Participation status of an appointment.</span> |





```

**Usages:**

* Examples for this Profile: [Appointment/appt-booked-physical](Appointment-appt-booked-physical.md), [Appointment/appt-cancelled](Appointment-appt-cancelled.md), [Appointment/appt-from-referral](Appointment-appt-from-referral.md), [Appointment/appt-fulfilled-followup](Appointment-appt-fulfilled-followup.md)... Show 2 more, [Appointment/appt-resulted-encounter](Appointment-appt-resulted-encounter.md) and [Appointment/appt-telehealth](Appointment-appt-telehealth.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/hl7.fhir.us.healthedata1-sandbox|current/StructureDefinition/StructureDefinition-us-core-appointment.json)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-us-core-appointment.csv), [Excel](StructureDefinition-us-core-appointment.xlsx), [Schematron](StructureDefinition-us-core-appointment.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "us-core-appointment",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 3
  }],
  "url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-appointment",
  "identifier" : [{
    "system" : "urn:ietf:rfc:3986",
    "value" : "urn:oid:2.16.840.1.113883.4.642.40.2.42.69"
  }],
  "version" : "0.1.0",
  "name" : "USCoreAppointmentProfile",
  "title" : "US Core Appointment Profile",
  "status" : "active",
  "experimental" : false,
  "date" : "2026-05-06",
  "publisher" : "HL7 International / Cross-Group Projects",
  "contact" : [{
    "name" : "HL7 International / Cross-Group Projects",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/cgp"
    },
    {
      "system" : "email",
      "value" : "cgp@lists.HL7.org"
    }]
  }],
  "description" : "The US Core Appointment Profile inherits from the FHIR [Appointment](https://hl7.org/fhir/R4/appointment.html) resource; refer to it for scope and usage definitions. This profile meets the requirements of the U.S. Core Data for Interoperability (USCDI) *Appointment Data Element of the Encounter Information Data Class*. It sets minimum expectations for the Appointment resource to record, search, and fetch information about a healthcare event scheduled for a past, current, or future date and time. It specifies which core elements, extensions, vocabularies, and value sets SHALL be present in the resource and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "workflow",
    "uri" : "http://hl7.org/fhir/workflow",
    "name" : "Workflow Pattern"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "ical",
    "uri" : "http://ietf.org/rfc/2445",
    "name" : "iCalendar"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Appointment",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Appointment",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Appointment",
      "path" : "Appointment"
    },
    {
      "id" : "Appointment.identifier",
      "path" : "Appointment.identifier",
      "min" : 0,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "Appointment.status",
      "path" : "Appointment.status",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true,
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/appointmentstatus"
      }
    },
    {
      "id" : "Appointment.serviceType",
      "path" : "Appointment.serviceType",
      "min" : 0,
      "max" : "*",
      "mustSupport" : true,
      "binding" : {
        "strength" : "example",
        "description" : "Value Sets are typically bound to local service catalogs, and mapping to standard vocabularies can not be expected.",
        "valueSet" : "https://profiles.ihe.net/ITI/Scheduling/ValueSet/sct-services"
      }
    },
    {
      "id" : "Appointment.start",
      "path" : "Appointment.start",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Appointment.end",
      "path" : "Appointment.end",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Appointment.participant",
      "path" : "Appointment.participant",
      "min" : 1,
      "max" : "*",
      "mustSupport" : true
    },
    {
      "id" : "Appointment.participant.type",
      "path" : "Appointment.participant.type",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/ValueSet/encounter-participant-type"
      }
    },
    {
      "id" : "Appointment.participant.actor",
      "path" : "Appointment.participant.actor",
      "min" : 1,
      "max" : "1",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-device",
        "http://hl7.org/fhir/StructureDefinition/HealthcareService",
        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"],
        "_targetProfile" : [{
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : true
          }]
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : false
          }]
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : false
          }]
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : false
          }]
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : false
          }]
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : false
          }]
        },
        {
          "extension" : [{
            "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support",
            "valueBoolean" : false
          }]
        }]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Appointment.participant.status",
      "path" : "Appointment.participant.status",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    }]
  }
}

```
