FHIR IG analytics| Package | servicewell.fhir.wof-connect |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-extraction-base.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/servicewell/servicewell.fhir.wof-connect/StructureDefinition-extraction-base.html |
| URL | http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/extraction-base |
| Version | 0.1.4 |
| Status | draft |
| Date | 2026-04-24T10:07:38+00:00 |
| Name | ExtractionBase |
| Title | Extraction Base (Extract Model) |
| Description | Standard base data (meta and data wrapper) captured with each extraction. |
| Type | http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/extraction-base |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition extraction-base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  extraction-base | 0..* | Base | Extraction Base (Extract Model) | |
  meta | 1..1 | BackboneElement | Standard metadata captured with each extraction. | |
  requestId | 1..1 | string | Unique identifier for the HTTP request | |
| extractDate | 1..1 | dateTime | UTC timestamp when data was extracted. Example Extraction timestamp: 2025-10-31T13:42:00Z | |
| sourceSystem | 1..1 | string | Source system identifier (frenda | opus). Example Source system: frenda | |
| sourceSystemVersion | 1..1 | string | Source system version (database or API version). Example Source system version: 1.7.23 | |
| FhirQueryParam | 0..* | BackboneElement | FHIR query parameters from the request (name/value pairs). | |
| name | 1..1 | string | Name of the query parameter. | |
| 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 | |
 extension | 0..0 | Extensions are not allowed on query parameter rows. | ||
  modifierExtension | 0..0 | Modifier extensions are not allowed on query parameter rows. | ||
| resourceSubPath | 0..1 | string | The optional remaining path segment after the FHIR resource type. Example Resource sub-path for GET /fhir/Organization/1234: /1234 | |
| interactionLevel | 0..1 | string | The interaction level of the FLC operation (resource | instance). Example Interaction level: instance | |
| extension | 0..0 | Extensions are not allowed in extraction metadata. | ||
| modifierExtension | 0..0 | Modifier extensions are not allowed in extraction metadata. | ||
| data | 1..1 | BackboneElement | Wrapper for data. | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "extraction-base",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/extraction-base",
"version": "0.1.4",
"name": "ExtractionBase",
"title": "Extraction Base (Extract Model)",
"status": "draft",
"date": "2026-04-24T10:07:38+00:00",
"publisher": "Service Well AB",
"contact": [
{
"name": "Service Well AB",
"telecom": [
{
"system": "url",
"value": "https://servicewell.se"
},
{
"system": "email",
"value": "info@servicewell.se"
}
]
}
],
"description": "Standard base data (meta and data wrapper) captured with each extraction.",
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/extraction-base",
"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": "extraction-base",
"path": "extraction-base",
"short": "Extraction Base (Extract Model)",
"definition": "Standard base data (meta and data wrapper) captured with each extraction.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "extraction-base.meta",
"path": "extraction-base.meta",
"short": "Standard metadata captured with each extraction.",
"definition": "Standard metadata captured with each extraction.",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "extraction-base.meta.id",
"path": "extraction-base.meta.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "extraction-base.meta.extension",
"path": "extraction-base.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"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.",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "extraction-base.meta.modifierExtension",
"path": "extraction-base.meta.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"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).",
"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.",
"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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "extraction-base.meta.requestId",
"path": "extraction-base.meta.requestId",
"short": "Unique identifier for the HTTP request",
"definition": "Unique identifier for the HTTP request",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta.requestId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "extraction-base.meta.extractDate",
"path": "extraction-base.meta.extractDate",
"short": "UTC timestamp when data was extracted.",
"definition": "UTC timestamp when data was extracted.",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta.extractDate",
"min": 1,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"example": [
{
"label": "Extraction timestamp",
"valueDateTime": "2025-10-31T13:42:00Z"
}
]
},
{
"id": "extraction-base.meta.sourceSystem",
"path": "extraction-base.meta.sourceSystem",
"short": "Source system identifier (frenda | opus).",
"definition": "Source system identifier (frenda | opus).",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta.sourceSystem",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Source system",
"valueString": "frenda"
}
]
},
{
"id": "extraction-base.meta.sourceSystemVersion",
"path": "extraction-base.meta.sourceSystemVersion",
"short": "Source system version (database or API version).",
"definition": "Source system version (database or API version).",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta.sourceSystemVersion",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Source system version",
"valueString": "1.7.23"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam",
"path": "extraction-base.meta.FhirQueryParam",
"short": "FHIR query parameters from the request (name/value pairs).",
"definition": "FHIR query parameters from the request (name/value pairs).",
"min": 0,
"max": "*",
"base": {
"path": "extraction-base.meta.FhirQueryParam",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.id",
"path": "extraction-base.meta.FhirQueryParam.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.extension",
"path": "extraction-base.meta.FhirQueryParam.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extensions are not allowed on query parameter rows.",
"definition": "Extensions are not allowed on query parameter rows.",
"min": 0,
"max": "0",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "extraction-base.meta.FhirQueryParam.modifierExtension",
"path": "extraction-base.meta.FhirQueryParam.modifierExtension",
"short": "Modifier extensions are not allowed on query parameter rows.",
"definition": "Modifier extensions are not allowed on query parameter rows.",
"min": 0,
"max": "0",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
},
{
"id": "extraction-base.meta.FhirQueryParam.name",
"path": "extraction-base.meta.FhirQueryParam.name",
"short": "Name of the query parameter.",
"definition": "Name of the query parameter.",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta.FhirQueryParam.name",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.value",
"path": "extraction-base.meta.FhirQueryParam.value",
"short": "Query string parameters from the FHIR request (everything after ?).",
"definition": "Query string parameters from the FHIR request (everything after ?).",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.meta.FhirQueryParam.value",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json",
"valueString": "_pretty=true&_format=json"
}
]
},
{
"id": "extraction-base.meta.resourceSubPath",
"path": "extraction-base.meta.resourceSubPath",
"short": "The optional remaining path segment after the FHIR resource type.",
"definition": "The optional remaining path segment after the FHIR resource type.",
"min": 0,
"max": "1",
"base": {
"path": "extraction-base.meta.resourceSubPath",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Resource sub-path for GET /fhir/Organization/1234",
"valueString": "/1234"
}
]
},
{
"id": "extraction-base.meta.interactionLevel",
"path": "extraction-base.meta.interactionLevel",
"short": "The interaction level of the FLC operation (resource | instance).",
"definition": "The interaction level of the FLC operation (resource | instance).",
"min": 0,
"max": "1",
"base": {
"path": "extraction-base.meta.interactionLevel",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Interaction level",
"valueString": "instance"
}
]
},
{
"id": "extraction-base.meta.extension",
"path": "extraction-base.meta.extension",
"short": "Extensions are not allowed in extraction metadata.",
"definition": "Extensions are not allowed in extraction metadata.",
"min": 0,
"max": "0",
"base": {
"path": "extraction-base.meta.extension",
"min": 0,
"max": "0"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "extraction-base.meta.modifierExtension",
"path": "extraction-base.meta.modifierExtension",
"short": "Modifier extensions are not allowed in extraction metadata.",
"definition": "Modifier extensions are not allowed in extraction metadata.",
"min": 0,
"max": "0",
"base": {
"path": "extraction-base.meta.modifierExtension",
"min": 0,
"max": "0"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "extraction-base.data",
"path": "extraction-base.data",
"short": "Wrapper for data.",
"definition": "Wrapper for data.",
"min": 1,
"max": "1",
"base": {
"path": "extraction-base.data",
"min": 1,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
]
}
]
},
"differential": {
"element": [
{
"id": "extraction-base",
"path": "extraction-base",
"short": "Extraction Base (Extract Model)",
"definition": "Standard base data (meta and data wrapper) captured with each extraction."
},
{
"id": "extraction-base.meta",
"path": "extraction-base.meta",
"short": "Standard metadata captured with each extraction.",
"definition": "Standard metadata captured with each extraction.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "extraction-base.meta.requestId",
"path": "extraction-base.meta.requestId",
"short": "Unique identifier for the HTTP request",
"definition": "Unique identifier for the HTTP request",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "extraction-base.meta.extractDate",
"path": "extraction-base.meta.extractDate",
"short": "UTC timestamp when data was extracted.",
"definition": "UTC timestamp when data was extracted.",
"min": 1,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"example": [
{
"label": "Extraction timestamp",
"valueDateTime": "2025-10-31T13:42:00Z"
}
]
},
{
"id": "extraction-base.meta.sourceSystem",
"path": "extraction-base.meta.sourceSystem",
"short": "Source system identifier (frenda | opus).",
"definition": "Source system identifier (frenda | opus).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Source system",
"valueString": "frenda"
}
]
},
{
"id": "extraction-base.meta.sourceSystemVersion",
"path": "extraction-base.meta.sourceSystemVersion",
"short": "Source system version (database or API version).",
"definition": "Source system version (database or API version).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Source system version",
"valueString": "1.7.23"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam",
"path": "extraction-base.meta.FhirQueryParam",
"short": "FHIR query parameters from the request (name/value pairs).",
"definition": "FHIR query parameters from the request (name/value pairs).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.name",
"path": "extraction-base.meta.FhirQueryParam.name",
"short": "Name of the query parameter.",
"definition": "Name of the query parameter.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.value",
"path": "extraction-base.meta.FhirQueryParam.value",
"short": "Query string parameters from the FHIR request (everything after ?).",
"definition": "Query string parameters from the FHIR request (everything after ?).",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "FHIR query parameters for GET /fhir/Organization/1234?_pretty=true&_format=json",
"valueString": "_pretty=true&_format=json"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.extension",
"path": "extraction-base.meta.FhirQueryParam.extension",
"short": "Extensions are not allowed on query parameter rows.",
"definition": "Extensions are not allowed on query parameter rows.",
"min": 0,
"max": "0",
"type": [
{
"code": "Extension"
}
]
},
{
"id": "extraction-base.meta.FhirQueryParam.modifierExtension",
"path": "extraction-base.meta.FhirQueryParam.modifierExtension",
"short": "Modifier extensions are not allowed on query parameter rows.",
"definition": "Modifier extensions are not allowed on query parameter rows.",
"min": 0,
"max": "0",
"type": [
{
"code": "Extension"
}
]
},
{
"id": "extraction-base.meta.resourceSubPath",
"path": "extraction-base.meta.resourceSubPath",
"short": "The optional remaining path segment after the FHIR resource type.",
"definition": "The optional remaining path segment after the FHIR resource type.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Resource sub-path for GET /fhir/Organization/1234",
"valueString": "/1234"
}
]
},
{
"id": "extraction-base.meta.interactionLevel",
"path": "extraction-base.meta.interactionLevel",
"short": "The interaction level of the FLC operation (resource | instance).",
"definition": "The interaction level of the FLC operation (resource | instance).",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "Interaction level",
"valueString": "instance"
}
]
},
{
"id": "extraction-base.meta.extension",
"path": "extraction-base.meta.extension",
"short": "Extensions are not allowed in extraction metadata.",
"definition": "Extensions are not allowed in extraction metadata.",
"min": 0,
"max": "0",
"type": [
{
"code": "Extension"
}
]
},
{
"id": "extraction-base.meta.modifierExtension",
"path": "extraction-base.meta.modifierExtension",
"short": "Modifier extensions are not allowed in extraction metadata.",
"definition": "Modifier extensions are not allowed in extraction metadata.",
"min": 0,
"max": "0",
"type": [
{
"code": "Extension"
}
]
},
{
"id": "extraction-base.data",
"path": "extraction-base.data",
"short": "Wrapper for data.",
"definition": "Wrapper for data.",
"min": 1,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
}
]
}
}