extraction-base
type: StructureDefinition
node role: treeRoot
id:
  v: extraction-base
text:
  status:
    v: extensions
  div:
    v: Generated Narrative: StructureDefinition extraction-base Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> extraction-base 0..* Base Extraction Base (Extract Model) #xD; meta 1..1 BackboneElement Standard metadata captured with each extraction. #xD; requestId 1..1 string Unique identifier for the HTTP request #xD; extractDate 1..1 dateTime UTC timestamp when data was extracted. Example Extraction timestamp: 2025-10-31T13:42:00Z #xD; sourceSystem 1..1 string Source system identifier (frenda | opus). Example Source system: frenda #xD; sourceSystemVersion 1..1 string Source system version (database or API version). Example Source system version: 1.7.23 #xD; FhirQueryParam 0..* BackboneElement FHIR query parameters from the request (name/value pairs). #xD; name 1..1 string Name of the query parameter. #xD; value 1..1 string Query string parameters from the FHIR request (everything after ?). Example FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json: _pretty=true&_format=json #xD; extension 0..0 Extensions are not allowed on query parameter rows. #xD; modifierExtension 0..0 Modifier extensions are not allowed on query parameter rows. #xD; resourceSubPath 0..1 string The optional remaining path segment after the FHIR resource type. Example Resource sub-path for GET /fhir/Organization/1234: /1234 #xD; interactionLevel 0..1 string The interaction level of the FLC operation (resource | instance). Example Interaction level: instance #xD; extension 0..0 Extensions are not allowed in extraction metadata. #xD; modifierExtension 0..0 Modifier extensions are not allowed in extraction metadata. #xD; data 1..1 BackboneElement Wrapper for data. #xD; <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
url:
  v: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/extraction-base
  l: extraction-base
version:
  v: 0.1.4
name:
  v: ExtractionBase
title:
  v: Extraction Base (Extract Model)
status:
  v: draft
date:
  v: 2026-04-24T10:07:38+00:00
publisher:
  v: Service Well AB
contact:
  name:
    v: Service Well AB
  telecom:
    system:
      v: url
    value:
      v: https://servicewell.se
  telecom:
    system:
      v: email
description:
  v: Standard base data (meta and data wrapper) captured with each extraction.
fhir version:
  v: 4.0.1
kind:
  v: logical
abstract:
  v: false
type:
  v: http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/extraction-base
  l: extraction-base
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Base
  l: Base
derivation:
  v: specialization
snapshot:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version
      l: snapshot-base-version
    value: String
      v: 4.0.1
  element:
    id:
      v: extraction-base
    path:
      v: extraction-base
    short:
      v: Extraction Base (Extract Model)
    definition:
      v: Standard base data (meta and data wrapper) captured with each extraction.
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Base
      min:
        v: 0
      max:
        v: *
    is modifier:
      v: false
  element:
    id:
      v: extraction-base.meta
    path:
      v: extraction-base.meta
    short:
      v: Standard metadata captured with each extraction.
    definition:
      v: Standard metadata captured with each extraction.
    min:
      v: 1
    max:
      v: 1
    base:
      path:
        v: extraction-base.meta
      min:
        v: 1
      max:
        v: 1
    type:
      code:
        v: BackboneElement
        l: BackboneElement
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element
  element:
    id:
      v: extraction-base.meta.id
    path:
      v: extraction-base.meta.id
    representation:
      v: xmlAttr
    short:
      v: Unique id for inter-element referencing
    definition:
      v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Element.id
      min:
        v: 0
      max:
        v: 1
    type:
      extension:
        value: Url
      code:
        v: http://hl7.org/fhirpath/System.String
        l: System.String
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: n/a
  element:
    id:
      v: extraction-base.meta.extension
    path:
      v: extraction-base.meta.extension
    slicing:
      description:
        v: Extensions are always sliced by (at least) url
      rules:
        v: open
    short:
      v: Additional content defined by implementations
    definition:
      v: 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.
    comment:
      v: 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.
    alias:
      v: extensions
    alias:
      v: user content
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Element.extension
      min:
        v: 0
      max:
        v: *
    type:
      code:
        v: Extension
        l: Extension
    constraint:
      key:
        v: ele-1
      severity:
        v: error
      human:
        v: All FHIR elements must have a @value or children
      expression:
        v: hasValue() or (children().count() > id.count())
      xpath:
        v: @value|f:*|h:div
      source:
        v: http://hl7.org/fhir/StructureDefinition/Element
        l: Element

Url
v: string
l: string

v: value

v: url

key:
  v: ext-1
severity:
  v: error
human:
  v: Must have either extensions or value[x], not both
expression:
  v: extension.exists() != value.exists()
xpath:
  v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
source:
  v: http://hl7.org/fhir/StructureDefinition/Extension
  l: Extension

v: false

v: false

identity:
  v: rim
map:
  v: n/a

id:
  v: extraction-base.meta.modifierExtension
path:
  v: extraction-base.meta.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: 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).
comment:
  v: 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.
requirements:
  v: 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).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: extraction-base.meta.requestId
path:
  v: extraction-base.meta.requestId
short:
  v: Unique identifier for the HTTP request
definition:
  v: Unique identifier for the HTTP request
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.meta.requestId
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: extraction-base.meta.extractDate
path:
  v: extraction-base.meta.extractDate
short:
  v: UTC timestamp when data was extracted.
definition:
  v: UTC timestamp when data was extracted.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.meta.extractDate
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: dateTime
    l: dateTime
example:
  label:
    v: Extraction timestamp
  value: DateTime
    v: 2025-10-31T13:42:00Z

id:
  v: extraction-base.meta.sourceSystem
path:
  v: extraction-base.meta.sourceSystem
short:
  v: Source system identifier (frenda | opus).
definition:
  v: Source system identifier (frenda | opus).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.meta.sourceSystem
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: Source system
  value: String
    v: frenda

id:
  v: extraction-base.meta.sourceSystemVersion
path:
  v: extraction-base.meta.sourceSystemVersion
short:
  v: Source system version (database or API version).
definition:
  v: Source system version (database or API version).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.meta.sourceSystemVersion
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: Source system version
  value: String
    v: 1.7.23

id:
  v: extraction-base.meta.FhirQueryParam
path:
  v: extraction-base.meta.FhirQueryParam
short:
  v: FHIR query parameters from the request (name/value pairs).
definition:
  v: FHIR query parameters from the request (name/value pairs).
min:
  v: 0
max:
  v: *
base:
  path:
    v: extraction-base.meta.FhirQueryParam
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
    l: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element

id:
  v: extraction-base.meta.FhirQueryParam.id
path:
  v: extraction-base.meta.FhirQueryParam.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
      l: structuredefinition-fhir-type
    value: Url
      v: string
      l: string
  code:
    v: http://hl7.org/fhirpath/System.String
    l: System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: extraction-base.meta.FhirQueryParam.extension
path:
  v: extraction-base.meta.FhirQueryParam.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Extensions are not allowed on query parameter rows.
definition:
  v: Extensions are not allowed on query parameter rows.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: extraction-base.meta.FhirQueryParam.modifierExtension
path:
  v: extraction-base.meta.FhirQueryParam.modifierExtension
short:
  v: Modifier extensions are not allowed on query parameter rows.
definition:
  v: Modifier extensions are not allowed on query parameter rows.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
    l: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    l: Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    l: Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true

id:
  v: extraction-base.meta.FhirQueryParam.name
path:
  v: extraction-base.meta.FhirQueryParam.name
short:
  v: Name of the query parameter.
definition:
  v: Name of the query parameter.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.meta.FhirQueryParam.name
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string

id:
  v: extraction-base.meta.FhirQueryParam.value
path:
  v: extraction-base.meta.FhirQueryParam.value
short:
  v: Query string parameters from the FHIR request (everything after ?).
definition:
  v: Query string parameters from the FHIR request (everything after ?).
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.meta.FhirQueryParam.value
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json
  value: String
    v: _pretty=true&_format=json

id:
  v: extraction-base.meta.resourceSubPath
path:
  v: extraction-base.meta.resourceSubPath
short:
  v: The optional remaining path segment after the FHIR resource type.
definition:
  v: The optional remaining path segment after the FHIR resource type.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: extraction-base.meta.resourceSubPath
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: Resource sub-path for GET /fhir/Organization/1234
  value: String
    v: /1234

id:
  v: extraction-base.meta.interactionLevel
path:
  v: extraction-base.meta.interactionLevel
short:
  v: The interaction level of the FLC operation (resource | instance).
definition:
  v: The interaction level of the FLC operation (resource | instance).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: extraction-base.meta.interactionLevel
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: Interaction level
  value: String
    v: instance

id:
  v: extraction-base.meta.extension
path:
  v: extraction-base.meta.extension
short:
  v: Extensions are not allowed in extraction metadata.
definition:
  v: Extensions are not allowed in extraction metadata.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: extraction-base.meta.extension
  min:
    v: 0
  max:
    v: 0
type:
  code:
    v: Extension
    l: Extension

id:
  v: extraction-base.meta.modifierExtension
path:
  v: extraction-base.meta.modifierExtension
short:
  v: Modifier extensions are not allowed in extraction metadata.
definition:
  v: Modifier extensions are not allowed in extraction metadata.
min:
  v: 0
max:
  v: 0
base:
  path:
    v: extraction-base.meta.modifierExtension
  min:
    v: 0
  max:
    v: 0
type:
  code:
    v: Extension
    l: Extension

id:
  v: extraction-base.data
path:
  v: extraction-base.data
short:
  v: Wrapper for data.
definition:
  v: Wrapper for data.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: extraction-base.data
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement

element:
  id:
    v: extraction-base
  path:
    v: extraction-base
  short:
    v: Extraction Base (Extract Model)
  definition:
    v: Standard base data (meta and data wrapper) captured with each extraction.
element:
  id:
    v: extraction-base.meta
  path:
    v: extraction-base.meta
  short:
    v: Standard metadata captured with each extraction.
  definition:
    v: Standard metadata captured with each extraction.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: BackboneElement
      l: BackboneElement
element:
  id:
    v: extraction-base.meta.requestId
  path:
    v: extraction-base.meta.requestId
  short:
    v: Unique identifier for the HTTP request
  definition:
    v: Unique identifier for the HTTP request
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: extraction-base.meta.extractDate
  path:
    v: extraction-base.meta.extractDate
  short:
    v: UTC timestamp when data was extracted.
  definition:
    v: UTC timestamp when data was extracted.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: dateTime
      l: dateTime
  example:
    label:
      v: Extraction timestamp
    value: DateTime
      v: 2025-10-31T13:42:00Z
element:
  id:
    v: extraction-base.meta.sourceSystem
  path:
    v: extraction-base.meta.sourceSystem
  short:
    v: Source system identifier (frenda | opus).
  definition:
    v: Source system identifier (frenda | opus).
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  example:
    label:
      v: Source system
    value: String
      v: frenda
element:
  id:
    v: extraction-base.meta.sourceSystemVersion
  path:
    v: extraction-base.meta.sourceSystemVersion
  short:
    v: Source system version (database or API version).
  definition:
    v: Source system version (database or API version).
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  example:
    label:
      v: Source system version
    value: String
      v: 1.7.23
element:
  id:
    v: extraction-base.meta.FhirQueryParam
  path:
    v: extraction-base.meta.FhirQueryParam
  short:
    v: FHIR query parameters from the request (name/value pairs).
  definition:
    v: FHIR query parameters from the request (name/value pairs).
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: BackboneElement
      l: BackboneElement
element:
  id:
    v: extraction-base.meta.FhirQueryParam.name
  path:
    v: extraction-base.meta.FhirQueryParam.name
  short:
    v: Name of the query parameter.
  definition:
    v: Name of the query parameter.
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
element:
  id:
    v: extraction-base.meta.FhirQueryParam.value
  path:
    v: extraction-base.meta.FhirQueryParam.value
  short:
    v: Query string parameters from the FHIR request (everything after ?).
  definition:
    v: Query string parameters from the FHIR request (everything after ?).
  min:
    v: 1
  max:
    v: 1
  type:
    code:
      v: string
      l: string
  example:
    label:
      v: FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json
    value: String
      v: _pretty=true&_format=json
element:
  id:
    v: extraction-base.meta.FhirQueryParam.extension
  path:
    v: extraction-base.meta.FhirQueryParam.extension
  short:
    v: Extensions are not allowed on query parameter rows.
  definition:
    v: Extensions are not allowed on query parameter rows.
  min:
    v: 0
  max:
    v: 0
  type:
    code:
      v: Extension
      l: Extension
element:
  id:
    v: extraction-base.meta.FhirQueryParam.modifierExtension
  path:
    v: extraction-base.meta.FhirQueryParam.modifierExtension
  short:
    v: Modifier extensions are not allowed on query parameter rows.
  definition:
    v: Modifier extensions are not allowed on query parameter rows.
  min:
    v: 0
  max:
    v: 0
  type:
    code:
      v: Extension
      l: Extension
element:
  id:
    v: extraction-base.meta.resourceSubPath

v: extraction-base.meta.resourceSubPath

v: The optional remaining path segment after the FHIR resource type.

v: The optional remaining path segment after the FHIR resource type.

v: 0

v: 1

code:
  v: string
  l: string

label:
  v: Resource sub-path for GET /fhir/Organization/1234
value: String
  v: /1234

id:
  v: extraction-base.meta.interactionLevel
path:
  v: extraction-base.meta.interactionLevel
short:
  v: The interaction level of the FLC operation (resource | instance).
definition:
  v: The interaction level of the FLC operation (resource | instance).
min:
  v: 0
max:
  v: 1
type:
  code:
    v: string
    l: string
example:
  label:
    v: Interaction level
  value: String
    v: instance

id:
  v: extraction-base.meta.extension
path:
  v: extraction-base.meta.extension
short:
  v: Extensions are not allowed in extraction metadata.
definition:
  v: Extensions are not allowed in extraction metadata.
min:
  v: 0
max:
  v: 0
type:
  code:
    v: Extension
    l: Extension

id:
  v: extraction-base.meta.modifierExtension
path:
  v: extraction-base.meta.modifierExtension
short:
  v: Modifier extensions are not allowed in extraction metadata.
definition:
  v: Modifier extensions are not allowed in extraction metadata.
min:
  v: 0
max:
  v: 0
type:
  code:
    v: Extension
    l: Extension

id:
  v: extraction-base.data
path:
  v: extraction-base.data
short:
  v: Wrapper for data.
definition:
  v: Wrapper for data.
min:
  v: 1
max:
  v: 1
type:
  code:
    v: BackboneElement
    l: BackboneElement