Frenda Wof-Connect FLC
0.1.3 -

This page is part of the Frenda Flc ig for Wof-Connect (v0.1.3: Pre-Release Update) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: GetPatientDetails (Extract Model)

Official URL: https://canonical.fhir.link/servicewell/frenda-wof-connect-flc/StructureDefinition/get-patient Version: 0.1.3
Draft as of 2026-10-14 Computable Name: GetPatientDetails

Extract model for retrieving patient details from /api/patient/details.

Usages:

  • This Logical Model is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. get-patient 0..* ExtractionBase GetPatientDetails (Extract Model)

Elements defined in Ancestors:meta, data
... meta 1..1 BackboneElement Standard metadata captured with each extraction.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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).
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extensions are not allowed on query parameter rows.
Slice: Unordered, Open by value:url
..... name 1..1 string Name of the query parameter.
..... value 1..1 string Value of the query parameter.
Example Identifier value for GET /fhir/Patient?identifier=199001072397: 199001072397
.... 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
... data 1..1 BackboneElement Wrapper for data.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... patientdetails 1..1 frenda-patient-details The patient details returned by Frenda for the given ssn token.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. get-patient 0..* ExtractionBase GetPatientDetails (Extract Model)

Elements defined in Ancestors:meta, data
... data
.... patientdetails 1..1 frenda-patient-details The patient details returned by Frenda for the given ssn token.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. get-patient 0..* ExtractionBase GetPatientDetails (Extract Model)

Elements defined in Ancestors:meta, data
... meta 1..1 BackboneElement Standard metadata captured with each extraction.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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).
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extensions are not allowed on query parameter rows.
Slice: Unordered, Open by value:url
..... name 1..1 string Name of the query parameter.
..... value 1..1 string Value of the query parameter.
Example Identifier value for GET /fhir/Patient?identifier=199001072397: 199001072397
.... 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
... data 1..1 BackboneElement Wrapper for data.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... patientdetails 1..1 frenda-patient-details The patient details returned by Frenda for the given ssn token.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(1 nested mandatory element)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. get-patient 0..* ExtractionBase GetPatientDetails (Extract Model)

Elements defined in Ancestors:meta, data
... meta 1..1 BackboneElement Standard metadata captured with each extraction.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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).
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extensions are not allowed on query parameter rows.
Slice: Unordered, Open by value:url
..... name 1..1 string Name of the query parameter.
..... value 1..1 string Value of the query parameter.
Example Identifier value for GET /fhir/Patient?identifier=199001072397: 199001072397
.... 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
... data 1..1 BackboneElement Wrapper for data.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... patientdetails 1..1 frenda-patient-details The patient details returned by Frenda for the given ssn token.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. get-patient 0..* ExtractionBase GetPatientDetails (Extract Model)

Elements defined in Ancestors:meta, data
... data
.... patientdetails 1..1 frenda-patient-details The patient details returned by Frenda for the given ssn token.

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. get-patient 0..* ExtractionBase GetPatientDetails (Extract Model)

Elements defined in Ancestors:meta, data
... meta 1..1 BackboneElement Standard metadata captured with each extraction.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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).
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extensions are not allowed on query parameter rows.
Slice: Unordered, Open by value:url
..... name 1..1 string Name of the query parameter.
..... value 1..1 string Value of the query parameter.
Example Identifier value for GET /fhir/Patient?identifier=199001072397: 199001072397
.... 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
... data 1..1 BackboneElement Wrapper for data.
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... patientdetails 1..1 frenda-patient-details The patient details returned by Frenda for the given ssn token.

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel