{
"description": "Extract model for retrieving Frenda's booking response.",
"_filename": "StructureDefinition-book-appointment-response.json",
"package_name": "servicewell.fhir.frenda-wof-connect-flc",
"date": "2026-10-14T13:18:33+00:00",
"derivation": "specialization",
"publisher": "Service Well AB",
"fhirVersion": "4.0.1",
"name": "BookAppointmentResponse",
"abstract": false,
"type": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/book-appointment-response",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "BookAppointmentResponse (Extract Model)",
"package_version": "0.1.3",
"snapshot": {
"element": [ {
"id": "book-appointment-response",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Base"
},
"path": "book-appointment-response",
"short": "BookAppointmentResponse (Extract Model)",
"definition": "Extract model for retrieving Frenda's booking response.",
"isModifier": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "book-appointment-response.meta",
"min": 1,
"definition": "Standard metadata captured with each extraction.",
"short": "Standard metadata captured with each extraction.",
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "book-appointment-response.meta",
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta"
}
}, {
"path": "book-appointment-response.meta.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "book-appointment-response.meta.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "book-appointment-response.meta.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "book-appointment-response.meta.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "book-appointment-response.meta.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "book-appointment-response.meta.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "book-appointment-response.meta.requestId",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta.requestId"
},
"path": "book-appointment-response.meta.requestId",
"type": [ {
"code": "string"
} ],
"short": "Unique identifier for the HTTP request",
"definition": "Unique identifier for the HTTP request"
}, {
"path": "book-appointment-response.meta.extractDate",
"min": 1,
"definition": "UTC timestamp when data was extracted.",
"short": "UTC timestamp when data was extracted.",
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "book-appointment-response.meta.extractDate",
"example": [ {
"label": "Extraction timestamp",
"valueDateTime": "2025-10-31T13:42:00Z"
} ],
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta.extractDate"
}
}, {
"path": "book-appointment-response.meta.sourceSystem",
"min": 1,
"definition": "Source system identifier (frenda | opus).",
"short": "Source system identifier (frenda | opus).",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "book-appointment-response.meta.sourceSystem",
"example": [ {
"label": "Source system",
"valueString": "frenda"
} ],
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta.sourceSystem"
}
}, {
"path": "book-appointment-response.meta.sourceSystemVersion",
"min": 1,
"definition": "Source system version (database or API version).",
"short": "Source system version (database or API version).",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "book-appointment-response.meta.sourceSystemVersion",
"example": [ {
"label": "Source system version",
"valueString": "1.7.23"
} ],
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta.sourceSystemVersion"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "book-appointment-response.meta.FhirQueryParam",
"min": 0,
"definition": "FHIR query parameters from the request (name/value pairs).",
"short": "FHIR query parameters from the request (name/value pairs).",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "book-appointment-response.meta.FhirQueryParam",
"base": {
"max": "*",
"min": 0,
"path": "extraction-base.meta.FhirQueryParam"
}
}, {
"path": "book-appointment-response.meta.FhirQueryParam.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "book-appointment-response.meta.FhirQueryParam.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "book-appointment-response.meta.FhirQueryParam.extension",
"min": 0,
"definition": "Extensions are not allowed on query parameter rows.",
"isModifier": false,
"short": "Extensions are not allowed on query parameter rows.",
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "book-appointment-response.meta.FhirQueryParam.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "book-appointment-response.meta.FhirQueryParam.modifierExtension",
"min": 0,
"definition": "Modifier extensions are not allowed on query parameter rows.",
"isModifier": true,
"short": "Modifier extensions are not allowed on query parameter rows.",
"type": [ {
"code": "Extension"
} ],
"max": "0",
"id": "book-appointment-response.meta.FhirQueryParam.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "book-appointment-response.meta.FhirQueryParam.name",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta.FhirQueryParam.name"
},
"path": "book-appointment-response.meta.FhirQueryParam.name",
"type": [ {
"code": "string"
} ],
"short": "Name of the query parameter.",
"definition": "Name of the query parameter."
}, {
"path": "book-appointment-response.meta.FhirQueryParam.value",
"min": 1,
"definition": "Value of the query parameter.",
"short": "Value of the query parameter.",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "book-appointment-response.meta.FhirQueryParam.value",
"example": [ {
"label": "Identifier value for GET /fhir/Patient?identifier=199001072397",
"valueString": "199001072397"
} ],
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.meta.FhirQueryParam.value"
}
}, {
"path": "book-appointment-response.meta.resourceSubPath",
"min": 0,
"definition": "The optional remaining path segment after the FHIR resource type.",
"short": "The optional remaining path segment after the FHIR resource type.",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "book-appointment-response.meta.resourceSubPath",
"example": [ {
"label": "Resource sub-path for GET /fhir/Organization/1234",
"valueString": "/1234"
} ],
"base": {
"max": "1",
"min": 0,
"path": "extraction-base.meta.resourceSubPath"
}
}, {
"path": "book-appointment-response.meta.interactionLevel",
"min": 0,
"definition": "The interaction level of the FLC operation (resource | instance).",
"short": "The interaction level of the FLC operation (resource | instance).",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "book-appointment-response.meta.interactionLevel",
"example": [ {
"label": "Interaction level",
"valueString": "instance"
} ],
"base": {
"max": "1",
"min": 0,
"path": "extraction-base.meta.interactionLevel"
}
}, {
"id": "book-appointment-response.data",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "extraction-base.data"
},
"path": "book-appointment-response.data",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Wrapper for data.",
"definition": "Wrapper for data."
}, {
"path": "book-appointment-response.data.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "book-appointment-response.data.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "book-appointment-response.data.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "book-appointment-response.data.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "book-appointment-response.data.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "book-appointment-response.data.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "book-appointment-response.data.bookingAppointment",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "book-appointment-response.data.bookingAppointment"
},
"path": "book-appointment-response.data.bookingAppointment",
"type": [ {
"code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-booking-response"
} ],
"short": "BookingResponse from Frenda.",
"definition": "BookingResponse from Frenda."
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "0.1.3"
} ]
},
"status": "draft",
"id": "3da187f6-2534-4888-be72-39d13d521c49",
"kind": "logical",
"url": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/book-appointment-response",
"version": "0.1.3",
"differential": {
"element": [ {
"id": "book-appointment-response",
"path": "book-appointment-response",
"short": "BookAppointmentResponse (Extract Model)",
"definition": "Extract model for retrieving Frenda's booking response."
}, {
"id": "book-appointment-response.data.bookingAppointment",
"max": "1",
"min": 1,
"path": "book-appointment-response.data.bookingAppointment",
"type": [ {
"code": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/frenda-booking-response"
} ],
"short": "BookingResponse from Frenda.",
"definition": "BookingResponse from Frenda."
} ]
},
"contact": [ {
"name": "Service Well AB",
"telecom": [ {
"value": "https://servicewell.se",
"system": "url"
} ]
} ],
"baseDefinition": "https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/extraction-base"
}