FHIRsmith: StructureDefinition/StructureDefinition-frenda-booking-response.json

FHIR IG analytics

Package	servicewell.fhir.frenda-wof-connect-flc
Resource Type	StructureDefinition
Id	StructureDefinition-frenda-booking-response.json
FHIR Version	R4
Source	https://build.fhir.org/ig/servicewell/servicewell.fhir.se.frenda-wof-connect-flc/StructureDefinition-frenda-booking-response.html
URL	https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-booking-response
Version	0.1.3
Status	draft
Date	2026-10-12T10:23:18+00:00
Name	FrendaBookingResponse
Title	Frenda Booking Response (Logical Model)
Type	https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-booking-response
Kind	logical

Resources that use this resource

StructureDefinition
servicewell.fhir.frenda-wof-connect-flc#current	book-appointment-response	BookAppointmentResponse (Extract Model)
servicewell.fhir.frenda-wof-connect-flc#current	get-appointment-by-id	GetAppointmentById (Extract Model)
servicewell.fhir.frenda-wof-connect-flc#current	get-appointments-by-patient	GetAppointmentsByPatient (Extract Model)

Resources that this resource uses

StructureDefinition
servicewell.fhir.frenda-wof-connect-flc#current	frenda-clinic	Frenda Clinic (Logical Model)
servicewell.fhir.frenda-wof-connect-flc#current	frenda-treater	Frenda Treater (Logical Model)
servicewell.fhir.frenda-wof-connect-flc#current	frenda-treatment	Frenda Treatment (Logical Model)

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition frenda-booking-response

Name	Card.	Type	Description & Constraints
frenda-booking-response	0..*	Base	Frenda Booking Response (Logical Model)
frenda-booking-response.id	1..1	string
frenda-booking-response.start	1..1	string	Start date and time of the appointment.
frenda-booking-response.duration	1..1	integer	Duration of the appointment.
frenda-booking-response.isCancellationAvailable	1..1	boolean	Possibility to cancel appointment. Configurable per clinic from Frenda Journal.
frenda-booking-response.isRescheduleAvailable	1..1	boolean	Possibility to reschedule appointment. Configurable per clinic from Frenda Journal.
frenda-booking-response.minChangeHours	1..1	integer	Minimal hours before appointment when it can be changed.
frenda-booking-response.webReschedulingCount	1..1	integer	Number of times that has been rescheduled using web booking.
frenda-booking-response.webReschedulingCountAllowed	1..1	integer	Number of times rescheduling is allowed.
frenda-booking-response.webCode	1..1	string	Web code of the appointment. Can be used for updating appointments.
frenda-booking-response.isWebBooked	1..1	boolean	Determines whether appointment is booked from API(1) or from Frenda System(0).
frenda-booking-response.status	1..1	string	Status of the appointment (Active, Complete or Cancelled).
frenda-booking-response.treatmentType	1..1	string	Treatment type of the appointment.
frenda-booking-response.reason	1..1	string	Reason of the appointment provided by patient. \| Patient comment from the booking.
frenda-booking-response.canAppointmentBeRescheduled	1..1	boolean	Determines whether the appointment can be rescheduled on a current time.
frenda-booking-response.canAppointmentBeCancelled	1..1	boolean	Determines whether the appointment can be cancelled on a current time.
frenda-booking-response.clinic	1..1	frenda-clinic	Clinic context.
frenda-booking-response.treater	1..1	frenda-treater	Treater for the booking.
frenda-booking-response.treatment	0..1	frenda-treatment	Treatment for the booking.
Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "frenda-booking-response",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-booking-response",
  "version": "0.1.3",
  "name": "FrendaBookingResponse",
  "title": "Frenda Booking Response (Logical Model)",
  "status": "draft",
  "date": "2026-10-12T10:23:18+00:00",
  "publisher": "Service Well AB",
  "contact": [
    {
      "name": "Service Well AB",
      "telecom": [
        {
          "system": "url",
          "value": "https://servicewell.se"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "kind": "logical",
  "abstract": false,
  "type": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-booking-response",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "frenda-booking-response",
        "path": "frenda-booking-response",
        "short": "Frenda Booking Response (Logical Model)",
        "definition": "Frenda Booking Response (Logical Model)",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "isModifier": false
      },
      {
        "id": "frenda-booking-response.id",
        "path": "frenda-booking-response.id",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.id",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.start",
        "path": "frenda-booking-response.start",
        "short": "Start date and time of the appointment.",
        "definition": "Start date and time of the appointment.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.start",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.duration",
        "path": "frenda-booking-response.duration",
        "short": "Duration of the appointment.",
        "definition": "Duration of the appointment.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.duration",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.isCancellationAvailable",
        "path": "frenda-booking-response.isCancellationAvailable",
        "short": "Possibility to cancel appointment. Configurable per clinic from Frenda Journal.",
        "definition": "Possibility to cancel appointment. Configurable per clinic from Frenda Journal.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.isCancellationAvailable",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.isRescheduleAvailable",
        "path": "frenda-booking-response.isRescheduleAvailable",
        "short": "Possibility to reschedule appointment. Configurable per clinic from Frenda Journal.",
        "definition": "Possibility to reschedule appointment. Configurable per clinic from Frenda Journal.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.isRescheduleAvailable",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.minChangeHours",
        "path": "frenda-booking-response.minChangeHours",
        "short": "Minimal hours before appointment when it can be changed.",
        "definition": "Minimal hours before appointment when it can be changed.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.minChangeHours",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.webReschedulingCount",
        "path": "frenda-booking-response.webReschedulingCount",
        "short": "Number of times that has been rescheduled using web booking.",
        "definition": "Number of times that has been rescheduled using web booking.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.webReschedulingCount",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.webReschedulingCountAllowed",
        "path": "frenda-booking-response.webReschedulingCountAllowed",
        "short": "Number of times rescheduling is allowed.",
        "definition": "Number of times rescheduling is allowed.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.webReschedulingCountAllowed",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.webCode",
        "path": "frenda-booking-response.webCode",
        "short": "Web code of the appointment. Can be used for updating appointments.",
        "definition": "Web code of the appointment. Can be used for updating appointments.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.webCode",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.isWebBooked",
        "path": "frenda-booking-response.isWebBooked",
        "short": "Determines whether appointment is booked from API(1) or from Frenda System(0).",
        "definition": "Determines whether appointment is booked from API(1) or from Frenda System(0).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.isWebBooked",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.status",
        "path": "frenda-booking-response.status",
        "short": "Status of the appointment (Active, Complete or Cancelled).",
        "definition": "Status of the appointment (Active, Complete or Cancelled).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.status",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.treatmentType",
        "path": "frenda-booking-response.treatmentType",
        "short": "Treatment type of the appointment.",
        "definition": "Treatment type of the appointment.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.treatmentType",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.reason",
        "path": "frenda-booking-response.reason",
        "short": "Reason of the appointment provided by patient. | Patient comment from the booking.",
        "definition": "Reason of the appointment provided by patient. | Patient comment from the booking.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.reason",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.canAppointmentBeRescheduled",
        "path": "frenda-booking-response.canAppointmentBeRescheduled",
        "short": "Determines whether the appointment can be rescheduled on a current time.",
        "definition": "Determines whether the appointment can be rescheduled on a current time.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.canAppointmentBeRescheduled",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.canAppointmentBeCancelled",
        "path": "frenda-booking-response.canAppointmentBeCancelled",
        "short": "Determines whether the appointment can be cancelled on a current time.",
        "definition": "Determines whether the appointment can be cancelled on a current time.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.canAppointmentBeCancelled",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.clinic",
        "path": "frenda-booking-response.clinic",
        "short": "Clinic context.",
        "definition": "Clinic context.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.clinic",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-clinic"
          }
        ]
      },
      {
        "id": "frenda-booking-response.treater",
        "path": "frenda-booking-response.treater",
        "short": "Treater for the booking.",
        "definition": "Treater for the booking.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.treater",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-treater"
          }
        ]
      },
      {
        "id": "frenda-booking-response.treatment",
        "path": "frenda-booking-response.treatment",
        "short": "Treatment for the booking.",
        "definition": "Treatment for the booking.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "frenda-booking-response.treatment",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-treatment"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "frenda-booking-response",
        "path": "frenda-booking-response",
        "short": "Frenda Booking Response (Logical Model)",
        "definition": "Frenda Booking Response (Logical Model)"
      },
      {
        "id": "frenda-booking-response.id",
        "path": "frenda-booking-response.id",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.start",
        "path": "frenda-booking-response.start",
        "short": "Start date and time of the appointment.",
        "definition": "Start date and time of the appointment.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.duration",
        "path": "frenda-booking-response.duration",
        "short": "Duration of the appointment.",
        "definition": "Duration of the appointment.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.isCancellationAvailable",
        "path": "frenda-booking-response.isCancellationAvailable",
        "short": "Possibility to cancel appointment. Configurable per clinic from Frenda Journal.",
        "definition": "Possibility to cancel appointment. Configurable per clinic from Frenda Journal.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.isRescheduleAvailable",
        "path": "frenda-booking-response.isRescheduleAvailable",
        "short": "Possibility to reschedule appointment. Configurable per clinic from Frenda Journal.",
        "definition": "Possibility to reschedule appointment. Configurable per clinic from Frenda Journal.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.minChangeHours",
        "path": "frenda-booking-response.minChangeHours",
        "short": "Minimal hours before appointment when it can be changed.",
        "definition": "Minimal hours before appointment when it can be changed.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.webReschedulingCount",
        "path": "frenda-booking-response.webReschedulingCount",
        "short": "Number of times that has been rescheduled using web booking.",
        "definition": "Number of times that has been rescheduled using web booking.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.webReschedulingCountAllowed",
        "path": "frenda-booking-response.webReschedulingCountAllowed",
        "short": "Number of times rescheduling is allowed.",
        "definition": "Number of times rescheduling is allowed.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "integer"
          }
        ]
      },
      {
        "id": "frenda-booking-response.webCode",
        "path": "frenda-booking-response.webCode",
        "short": "Web code of the appointment. Can be used for updating appointments.",
        "definition": "Web code of the appointment. Can be used for updating appointments.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.isWebBooked",
        "path": "frenda-booking-response.isWebBooked",
        "short": "Determines whether appointment is booked from API(1) or from Frenda System(0).",
        "definition": "Determines whether appointment is booked from API(1) or from Frenda System(0).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.status",
        "path": "frenda-booking-response.status",
        "short": "Status of the appointment (Active, Complete or Cancelled).",
        "definition": "Status of the appointment (Active, Complete or Cancelled).",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.treatmentType",
        "path": "frenda-booking-response.treatmentType",
        "short": "Treatment type of the appointment.",
        "definition": "Treatment type of the appointment.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.reason",
        "path": "frenda-booking-response.reason",
        "short": "Reason of the appointment provided by patient. | Patient comment from the booking.",
        "definition": "Reason of the appointment provided by patient. | Patient comment from the booking.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "frenda-booking-response.canAppointmentBeRescheduled",
        "path": "frenda-booking-response.canAppointmentBeRescheduled",
        "short": "Determines whether the appointment can be rescheduled on a current time.",
        "definition": "Determines whether the appointment can be rescheduled on a current time.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.canAppointmentBeCancelled",
        "path": "frenda-booking-response.canAppointmentBeCancelled",
        "short": "Determines whether the appointment can be cancelled on a current time.",
        "definition": "Determines whether the appointment can be cancelled on a current time.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "id": "frenda-booking-response.clinic",
        "path": "frenda-booking-response.clinic",
        "short": "Clinic context.",
        "definition": "Clinic context.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-clinic"
          }
        ]
      },
      {
        "id": "frenda-booking-response.treater",
        "path": "frenda-booking-response.treater",
        "short": "Treater for the booking.",
        "definition": "Treater for the booking.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-treater"
          }
        ]
      },
      {
        "id": "frenda-booking-response.treatment",
        "path": "frenda-booking-response.treatment",
        "short": "Treatment for the booking.",
        "definition": "Treatment for the booking.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-treatment"
          }
        ]
      }
    ]
  }
}