WOF Connect
0.1.4 - ci-build [WIP]
WOF Connect
0.1.4 - ci-build [WIP]
WOF Connect, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.4 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions
| Draft as of 2026-04-24 |
Definitions for the extraction-base logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. extraction-base | |
| Definition | Standard base data (meta and data wrapper) captured with each extraction. |
| Short | Extraction Base (Extract Model) |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. extraction-base.meta | |
| Definition | Standard metadata captured with each extraction. |
| Short | Standard metadata captured with each extraction. |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. extraction-base.meta.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. extraction-base.meta.extension | |
| 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. |
| Short | Additional content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on extraction-base.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. extraction-base.meta.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. extraction-base.meta.requestId | |
| Definition | Unique identifier for the HTTP request |
| Short | Unique identifier for the HTTP request |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. extraction-base.meta.extractDate | |
| Definition | UTC timestamp when data was extracted. |
| Short | UTC timestamp when data was extracted. |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Extraction timestamp: 2025-10-31T13:42:00Z |
| 14. extraction-base.meta.sourceSystem | |
| Definition | Source system identifier (frenda | opus). |
| Short | Source system identifier (frenda | opus). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Source system: frenda |
| 16. extraction-base.meta.sourceSystemVersion | |
| Definition | Source system version (database or API version). |
| Short | Source system version (database or API version). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Source system version: 1.7.23 |
| 18. extraction-base.meta.FhirQueryParam | |
| Definition | FHIR query parameters from the request (name/value pairs). |
| Short | FHIR query parameters from the request (name/value pairs). |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. extraction-base.meta.FhirQueryParam.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 22. extraction-base.meta.FhirQueryParam.extension | |
| Definition | Extensions are not allowed on query parameter rows. 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. |
| Short | Extensions are not allowed on query parameter rows.Additional content defined by implementations |
| Comments | 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on extraction-base.meta.FhirQueryParam.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. extraction-base.meta.FhirQueryParam.modifierExtension | |
| Definition | Modifier extensions are not allowed on query parameter rows. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Modifier extensions are not allowed on query parameter rows.Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..0* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 26. extraction-base.meta.FhirQueryParam.name | |
| Definition | Name of the query parameter. |
| Short | Name of the query parameter. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. extraction-base.meta.FhirQueryParam.value | |
| Definition | Query string parameters from the FHIR request (everything after ?). |
| Short | Query string parameters from the FHIR request (everything after ?). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json: _pretty=true&_format=json |
| 30. extraction-base.meta.resourceSubPath | |
| Definition | The optional remaining path segment after the FHIR resource type. |
| Short | The optional remaining path segment after the FHIR resource type. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Resource sub-path for GET /fhir/Organization/1234: /1234 |
| 32. extraction-base.meta.interactionLevel | |
| Definition | The interaction level of the FLC operation (resource | instance). |
| Short | The interaction level of the FLC operation (resource | instance). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Interaction level: instance |
| 34. extraction-base.meta.extension | |
| Definition | Extensions are not allowed in extraction metadata. |
| Short | Extensions are not allowed in extraction metadata. |
| Control | 0..0 |
| Type | Extension |
| 36. extraction-base.meta.modifierExtension | |
| Definition | Modifier extensions are not allowed in extraction metadata. |
| Short | Modifier extensions are not allowed in extraction metadata. |
| Control | 0..0 |
| Type | Extension |
| 38. extraction-base.data | |
| Definition | Wrapper for data. |
| Short | Wrapper for data. |
| Control | 1..1 |
| Type | BackboneElement |
Guidance on how to interpret the contents of this table can be foundhere
| 0. extraction-base | |
| Definition | Standard base data (meta and data wrapper) captured with each extraction. |
| Short | Extraction Base (Extract Model) |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. extraction-base.meta | |
| Definition | Standard metadata captured with each extraction. |
| Short | Standard metadata captured with each extraction. |
| Control | 1..1 |
| Type | BackboneElement |
| 4. extraction-base.meta.requestId | |
| Definition | Unique identifier for the HTTP request |
| Short | Unique identifier for the HTTP request |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. extraction-base.meta.extractDate | |
| Definition | UTC timestamp when data was extracted. |
| Short | UTC timestamp when data was extracted. |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Extraction timestamp: 2025-10-31T13:42:00Z |
| 8. extraction-base.meta.sourceSystem | |
| Definition | Source system identifier (frenda | opus). |
| Short | Source system identifier (frenda | opus). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Source system: frenda |
| 10. extraction-base.meta.sourceSystemVersion | |
| Definition | Source system version (database or API version). |
| Short | Source system version (database or API version). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Source system version: 1.7.23 |
| 12. extraction-base.meta.FhirQueryParam | |
| Definition | FHIR query parameters from the request (name/value pairs). |
| Short | FHIR query parameters from the request (name/value pairs). |
| Control | 0..* |
| Type | BackboneElement |
| 14. extraction-base.meta.FhirQueryParam.name | |
| Definition | Name of the query parameter. |
| Short | Name of the query parameter. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. extraction-base.meta.FhirQueryParam.value | |
| Definition | Query string parameters from the FHIR request (everything after ?). |
| Short | Query string parameters from the FHIR request (everything after ?). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json: _pretty=true&_format=json |
| 18. extraction-base.meta.FhirQueryParam.extension | |
| Definition | Extensions are not allowed on query parameter rows. |
| Short | Extensions are not allowed on query parameter rows. |
| Control | 0..0 |
| Type | Extension |
| 20. extraction-base.meta.FhirQueryParam.modifierExtension | |
| Definition | Modifier extensions are not allowed on query parameter rows. |
| Short | Modifier extensions are not allowed on query parameter rows. |
| Control | 0..0 |
| Type | Extension |
| 22. extraction-base.meta.resourceSubPath | |
| Definition | The optional remaining path segment after the FHIR resource type. |
| Short | The optional remaining path segment after the FHIR resource type. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Resource sub-path for GET /fhir/Organization/1234: /1234 |
| 24. extraction-base.meta.interactionLevel | |
| Definition | The interaction level of the FLC operation (resource | instance). |
| Short | The interaction level of the FLC operation (resource | instance). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Interaction level: instance |
| 26. extraction-base.meta.extension | |
| Definition | Extensions are not allowed in extraction metadata. |
| Short | Extensions are not allowed in extraction metadata. |
| Control | 0..0 |
| Type | Extension |
| 28. extraction-base.meta.modifierExtension | |
| Definition | Modifier extensions are not allowed in extraction metadata. |
| Short | Modifier extensions are not allowed in extraction metadata. |
| Control | 0..0 |
| Type | Extension |
| 30. extraction-base.data | |
| Definition | Wrapper for data. |
| Short | Wrapper for data. |
| Control | 1..1 |
| Type | BackboneElement |
Guidance on how to interpret the contents of this table can be foundhere
| 0. extraction-base | |
| Definition | Standard base data (meta and data wrapper) captured with each extraction. |
| Short | Extraction Base (Extract Model) |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. extraction-base.meta | |
| Definition | Standard metadata captured with each extraction. |
| Short | Standard metadata captured with each extraction. |
| Control | 1..1 |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. extraction-base.meta.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. extraction-base.meta.extension | |
| 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. |
| Short | Additional content defined by implementations |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on extraction-base.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. extraction-base.meta.modifierExtension | |
| 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. extraction-base.meta.requestId | |
| Definition | Unique identifier for the HTTP request |
| Short | Unique identifier for the HTTP request |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. extraction-base.meta.extractDate | |
| Definition | UTC timestamp when data was extracted. |
| Short | UTC timestamp when data was extracted. |
| Control | 1..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Extraction timestamp: 2025-10-31T13:42:00Z |
| 14. extraction-base.meta.sourceSystem | |
| Definition | Source system identifier (frenda | opus). |
| Short | Source system identifier (frenda | opus). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Source system: frenda |
| 16. extraction-base.meta.sourceSystemVersion | |
| Definition | Source system version (database or API version). |
| Short | Source system version (database or API version). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Source system version: 1.7.23 |
| 18. extraction-base.meta.FhirQueryParam | |
| Definition | FHIR query parameters from the request (name/value pairs). |
| Short | FHIR query parameters from the request (name/value pairs). |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 20. extraction-base.meta.FhirQueryParam.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 22. extraction-base.meta.FhirQueryParam.extension | |
| Definition | Extensions are not allowed on query parameter rows. |
| Short | Extensions are not allowed on query parameter rows. |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on extraction-base.meta.FhirQueryParam.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 24. extraction-base.meta.FhirQueryParam.modifierExtension | |
| Definition | Modifier extensions are not allowed on query parameter rows. |
| Short | Modifier extensions are not allowed on query parameter rows. |
| Control | 0..0 |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 26. extraction-base.meta.FhirQueryParam.name | |
| Definition | Name of the query parameter. |
| Short | Name of the query parameter. |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 28. extraction-base.meta.FhirQueryParam.value | |
| Definition | Query string parameters from the FHIR request (everything after ?). |
| Short | Query string parameters from the FHIR request (everything after ?). |
| Control | 1..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json: _pretty=true&_format=json |
| 30. extraction-base.meta.resourceSubPath | |
| Definition | The optional remaining path segment after the FHIR resource type. |
| Short | The optional remaining path segment after the FHIR resource type. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Resource sub-path for GET /fhir/Organization/1234: /1234 |
| 32. extraction-base.meta.interactionLevel | |
| Definition | The interaction level of the FLC operation (resource | instance). |
| Short | The interaction level of the FLC operation (resource | instance). |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Example | Interaction level: instance |
| 34. extraction-base.meta.extension | |
| Definition | Extensions are not allowed in extraction metadata. |
| Short | Extensions are not allowed in extraction metadata. |
| Control | 0..0 |
| Type | Extension |
| 36. extraction-base.meta.modifierExtension | |
| Definition | Modifier extensions are not allowed in extraction metadata. |
| Short | Modifier extensions are not allowed in extraction metadata. |
| Control | 0..0 |
| Type | Extension |
| 38. extraction-base.data | |
| Definition | Wrapper for data. |
| Short | Wrapper for data. |
| Control | 1..1 |
| Type | BackboneElement |