eHealth Infrastructure
3.1.0 - release

This page is part of the FUT Infrastructure (v3.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ehealth-appointment - Examples

Examples for the ehealth-appointment Profile:

  • appointment01
  • StructureDefinition: ehealth-appointment - Operation examples

    POST [base]/Appointment

    Header

    Accept-Charset: utf-8
    Accept: application/fhir+json;q=1.0, application/json+fhir;q=0.9
    User-Agent: HAPI-FHIR/5.5.0 (FHIR Client; FHIR 4.0.1/R4; apache)
    Accept-Encoding: gzip
    Content-Type: application/fhir+json; charset=UTF-8
    

    Body:

    {
      "resourceType" : "Appointment",
      "meta" : {
        "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment" ]
      },
      "contained" : [ {
        "resourceType" : "Location",
        "id" : "1",
        "name" : "Meeting Room 1",
        "telecom" : [ {
          "system" : "email",
          "value" : "location@example.com"
        } ],
        "address" : {
          "line" : [ "Trifork", "Europaplads 2" ],
          "city" : "Aarhus C",
          "postalCode" : "8000",
          "country" : "DK"
        }
      } ],
      "extension" : [ {
        "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible",
        "valueReference" : {
          "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
        }
      } ],
      "status" : "booked",
      "serviceType" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-servicetype",
          "code" : "regular"
        } ]
      } ],
      "appointmentType" : {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
          "code" : "FOLLOWUP"
        } ]
      },
      "reasonCode" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-reason",
          "code" : "412776001"
        } ]
      } ],
      "priority" : 1,
      "description" : "Forundersøgelse",
      "start" : "2021-09-10T09:00:00.000+00:00",
      "end" : "2021-09-10T11:00:00.000+00:00",
      "comment" : "Forundersøgelse for grå stær hos Trifork.\n Patienten møder op hos Trifork med udfyldt spørgeskema",
      "participant" : [ {
        "extension" : [ {
          "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam",
          "valueReference" : {
            "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
          }
        } ],
        "type" : [ {
          "coding" : [ {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PART",
            "display" : "Participation"
          } ]
        } ],
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "https://organization.fut.trifork.com/fhir/Practitioner/107302",
          "display" : "actor1 display text"
        },
        "required" : "required",
        "status" : "tentative"
      }, {
        "actor" : {
          "reference" : "https://patient.fut.trifork.com/fhir/Patient/179103"
        },
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "#1"
        },
        "required" : "required",
        "status" : "accepted"
      } ]
    }
    

    Response

    {
      "resourceType" : "Appointment",
      "id" : "180815",
      "meta" : {
        "versionId" : "1",
        "lastUpdated" : "2021-09-09T07:07:56.661+00:00",
        "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment" ]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Forundersøgelse</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Id</td><td/></tr><tr><td>Appointment Type</td><td><span>FOLLOWUP</span></td></tr><tr><td>Status</td><td><span>Booked</span></td></tr></tbody></table></div>"
      },
      "contained" : [ {
        "resourceType" : "Location",
        "id" : "1",
        "name" : "Meeting Room 1",
        "telecom" : [ {
          "system" : "email",
          "value" : "location@example.com"
        } ],
        "address" : {
          "line" : [ "Trifork", "Europaplads 2" ],
          "city" : "Aarhus C",
          "postalCode" : "8000",
          "country" : "DK"
        }
      } ],
      "extension" : [ {
        "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible",
        "valueReference" : {
          "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
        }
      } ],
      "identifier" : [ {
        "system" : "http://ehealth.sundhed.dk/id/ehealth-identifier",
        "value" : "6a7389e7-02a9-49ad-b170-275c77233ca6"
      } ],
      "status" : "booked",
      "serviceType" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-servicetype",
          "code" : "regular"
        } ]
      } ],
      "appointmentType" : {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
          "code" : "FOLLOWUP"
        } ]
      },
      "reasonCode" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-reason",
          "code" : "412776001"
        } ]
      } ],
      "priority" : 1,
      "description" : "Forundersøgelse",
      "start" : "2021-09-10T09:00:00.000+00:00",
      "end" : "2021-09-10T11:00:00.000+00:00",
      "comment" : "Forundersøgelse for grå stær hos Trifork.\n Patienten møder op hos Trifork med udfyldt spørgeskema",
      "participant" : [ {
        "extension" : [ {
          "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam",
          "valueReference" : {
            "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
          }
        } ],
        "type" : [ {
          "coding" : [ {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PART",
            "display" : "Participation"
          } ]
        } ],
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "https://organization.fut.trifork.com/fhir/Practitioner/107302",
          "display" : "actor1 display text"
        },
        "required" : "required",
        "status" : "tentative"
      }, {
        "actor" : {
          "reference" : "https://patient.fut.trifork.com/fhir/Patient/179103"
        },
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "#1"
        },
        "required" : "required",
        "status" : "accepted"
      } ]
    }
    

    GET [base]/Appointment/180770

    Header

    Accept-Charset: utf-8
    Accept: application/fhir+xml;q=1.0, application/fhir+json;q=1.0, application/xml+fhir;q=0.9, application/json+fhir;q=0.9
    User-Agent: HAPI-FHIR/5.5.0 (FHIR Client; FHIR 4.0.1/R4; apache)
    Accept-Encoding: gzip
    

    Body:

    
    

    Response

    {
      "resourceType" : "Appointment",
      "id" : "180770",
      "meta" : {
        "versionId" : "3",
        "lastUpdated" : "2021-09-09T07:07:53.842+00:00",
        "source" : "#01c604e9-9fcb-4b",
        "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment" ]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Forundersøgelse</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Id</td><td/></tr><tr><td>Appointment Type</td><td><span>FOLLOWUP</span></td></tr><tr><td>Status</td><td><span>Booked</span></td></tr></tbody></table></div>"
      },
      "contained" : [ {
        "resourceType" : "Location",
        "id" : "1",
        "name" : "Room 43b"
      } ],
      "extension" : [ {
        "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible",
        "valueReference" : {
          "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
        }
      } ],
      "identifier" : [ {
        "system" : "http://ehealth.sundhed.dk/id/ehealth-identifier",
        "value" : "401dc353-668c-4ecc-a95e-533ef0d5d609"
      } ],
      "status" : "booked",
      "serviceType" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-servicetype",
          "code" : "regular"
        } ]
      } ],
      "appointmentType" : {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
          "code" : "EMERGENCY"
        } ]
      },
      "reasonCode" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-reason",
          "code" : "412776001"
        } ]
      } ],
      "priority" : 1,
      "description" : "Forundersøgelse",
      "start" : "2021-09-10T09:00:00.000+00:00",
      "end" : "2021-09-10T11:00:00.000+00:00",
      "comment" : "Forundersøgelse for grå stær hos Trifork.\n Patienten møder op hos Trifork med udfyldt spørgeskema",
      "participant" : [ {
        "extension" : [ {
          "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam",
          "valueReference" : {
            "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
          }
        } ],
        "type" : [ {
          "coding" : [ {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PART",
            "display" : "Participation"
          } ]
        } ],
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "https://organization.fut.trifork.com/fhir/Practitioner/107302",
          "display" : "actor1 display text"
        },
        "required" : "required",
        "status" : "tentative"
      }, {
        "actor" : {
          "reference" : "https://patient.fut.trifork.com/fhir/Patient/179103"
        },
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "#1"
        },
        "required" : "required",
        "status" : "accepted"
      } ]
    }
    

    PUT [base]/Appointment/180770

    Header

    Accept-Charset: utf-8
    If-Match: "1"
    Accept: application/fhir+json;q=1.0, application/json+fhir;q=0.9
    User-Agent: HAPI-FHIR/5.5.0 (FHIR Client; FHIR 4.0.1/R4; apache)
    Accept-Encoding: gzip
    Content-Type: application/fhir+json; charset=UTF-8
    

    Body:

    {
      "resourceType" : "Appointment",
      "id" : "180770",
      "meta" : {
        "versionId" : "1",
        "lastUpdated" : "2021-09-09T07:07:51.286+00:00",
        "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment" ]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Forundersøgelse</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Id</td><td/></tr><tr><td>Appointment Type</td><td><span>FOLLOWUP</span></td></tr><tr><td>Status</td><td><span>Booked</span></td></tr></tbody></table></div>"
      },
      "contained" : [ {
        "resourceType" : "Location",
        "id" : "1",
        "name" : "Room 43b"
      } ],
      "extension" : [ {
        "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible",
        "valueReference" : {
          "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
        }
      } ],
      "identifier" : [ {
        "system" : "http://ehealth.sundhed.dk/id/ehealth-identifier",
        "value" : "401dc353-668c-4ecc-a95e-533ef0d5d609"
      } ],
      "status" : "booked",
      "serviceType" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-servicetype",
          "code" : "regular"
        } ]
      } ],
      "appointmentType" : {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
          "code" : "FOLLOWUP"
        } ]
      },
      "reasonCode" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-reason",
          "code" : "412776001"
        } ]
      } ],
      "priority" : 1,
      "description" : "Forundersøgelse",
      "start" : "2021-09-10T09:00:00.000+00:00",
      "end" : "2021-09-10T11:00:00.000+00:00",
      "comment" : "Forundersøgelse for grå stær hos Trifork.\n Patienten møder op hos Trifork med udfyldt spørgeskema",
      "participant" : [ {
        "extension" : [ {
          "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam",
          "valueReference" : {
            "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
          }
        } ],
        "type" : [ {
          "coding" : [ {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PART",
            "display" : "Participation"
          } ]
        } ],
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "https://organization.fut.trifork.com/fhir/Practitioner/107302",
          "display" : "actor1 display text"
        },
        "required" : "required",
        "status" : "tentative"
      }, {
        "actor" : {
          "reference" : "https://patient.fut.trifork.com/fhir/Patient/179103"
        },
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "#1"
        },
        "required" : "required",
        "status" : "accepted"
      } ]
    }
    

    Response

    {
      "resourceType" : "Appointment",
      "id" : "180770",
      "meta" : {
        "versionId" : "2",
        "lastUpdated" : "2021-09-09T07:07:51.877+00:00",
        "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment" ]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Forundersøgelse</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Id</td><td/></tr><tr><td>Appointment Type</td><td><span>FOLLOWUP</span></td></tr><tr><td>Status</td><td><span>Booked</span></td></tr></tbody></table></div>"
      },
      "contained" : [ {
        "resourceType" : "Location",
        "id" : "1",
        "name" : "Room 43b"
      } ],
      "extension" : [ {
        "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible",
        "valueReference" : {
          "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
        }
      } ],
      "identifier" : [ {
        "system" : "http://ehealth.sundhed.dk/id/ehealth-identifier",
        "value" : "401dc353-668c-4ecc-a95e-533ef0d5d609"
      } ],
      "status" : "booked",
      "serviceType" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-servicetype",
          "code" : "regular"
        } ]
      } ],
      "appointmentType" : {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
          "code" : "FOLLOWUP"
        } ]
      },
      "reasonCode" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-reason",
          "code" : "412776001"
        } ]
      } ],
      "priority" : 1,
      "description" : "Forundersøgelse",
      "start" : "2021-09-10T09:00:00.000+00:00",
      "end" : "2021-09-10T11:00:00.000+00:00",
      "comment" : "Forundersøgelse for grå stær hos Trifork.\n Patienten møder op hos Trifork med udfyldt spørgeskema",
      "participant" : [ {
        "extension" : [ {
          "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam",
          "valueReference" : {
            "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
          }
        } ],
        "type" : [ {
          "coding" : [ {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PART",
            "display" : "Participation"
          } ]
        } ],
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "https://organization.fut.trifork.com/fhir/Practitioner/107302",
          "display" : "actor1 display text"
        },
        "required" : "required",
        "status" : "tentative"
      }, {
        "actor" : {
          "reference" : "https://patient.fut.trifork.com/fhir/Patient/179103"
        },
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "#1"
        },
        "required" : "required",
        "status" : "accepted"
      } ]
    }
    

    PATCH [base]/Appointment/180770

    Header

    Accept-Charset: utf-8
    Accept: application/fhir+xml;q=1.0, application/fhir+json;q=1.0, application/xml+fhir;q=0.9, application/json+fhir;q=0.9
    User-Agent: HAPI-FHIR/5.5.0 (FHIR Client; FHIR 4.0.1/R4; apache)
    Accept-Encoding: gzip
    Content-Type: application/json-patch+json; charset=UTF-8
    

    Body:

    [ {
      "op" : "add",
      "path" : "/appointmentType/coding",
      "value" : [ {
        "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
        "code" : "EMERGENCY"
      } ]
    } ]
    

    Response

    {
      "resourceType" : "Appointment",
      "id" : "180770",
      "meta" : {
        "versionId" : "3",
        "lastUpdated" : "2021-09-09T07:07:53.842+00:00",
        "source" : "#275f5e83-7bd1-42",
        "profile" : [ "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-appointment" ]
      },
      "text" : {
        "status" : "generated",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><div class=\"hapiHeaderText\">Forundersøgelse</div><table class=\"hapiPropertyTable\"><tbody><tr><td>Id</td><td/></tr><tr><td>Appointment Type</td><td><span>FOLLOWUP</span></td></tr><tr><td>Status</td><td><span>Booked</span></td></tr></tbody></table></div>"
      },
      "contained" : [ {
        "resourceType" : "Location",
        "id" : "1",
        "name" : "Room 43b"
      } ],
      "extension" : [ {
        "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-responsible",
        "valueReference" : {
          "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
        }
      } ],
      "identifier" : [ {
        "system" : "http://ehealth.sundhed.dk/id/ehealth-identifier",
        "value" : "401dc353-668c-4ecc-a95e-533ef0d5d609"
      } ],
      "status" : "booked",
      "serviceType" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-servicetype",
          "code" : "regular"
        } ]
      } ],
      "appointmentType" : {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointmenttype-codes",
          "code" : "EMERGENCY"
        } ]
      },
      "reasonCode" : [ {
        "coding" : [ {
          "system" : "http://ehealth.sundhed.dk/cs/appointment-reason",
          "code" : "412776001"
        } ]
      } ],
      "priority" : 1,
      "description" : "Forundersøgelse",
      "start" : "2021-09-10T09:00:00.000+00:00",
      "end" : "2021-09-10T11:00:00.000+00:00",
      "comment" : "Forundersøgelse for grå stær hos Trifork.\n Patienten møder op hos Trifork med udfyldt spørgeskema",
      "participant" : [ {
        "extension" : [ {
          "url" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-ext-careteam",
          "valueReference" : {
            "reference" : "https://organization.fut.trifork.com/fhir/CareTeam/108752"
          }
        } ],
        "type" : [ {
          "coding" : [ {
            "system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
            "code" : "PART",
            "display" : "Participation"
          } ]
        } ],
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "https://organization.fut.trifork.com/fhir/Practitioner/107302",
          "display" : "actor1 display text"
        },
        "required" : "required",
        "status" : "tentative"
      }, {
        "actor" : {
          "reference" : "https://patient.fut.trifork.com/fhir/Patient/179103"
        },
        "required" : "required",
        "status" : "accepted"
      }, {
        "actor" : {
          "reference" : "#1"
        },
        "required" : "required",
        "status" : "accepted"
      } ]
    }