GetCarePlans - Response - Definitions - clinicalprocess: logistics:logistics v0.1.0

clinicalprocess: logistics:logistics - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Logical Model: GetcareplansResponseLM - Detailed Descriptions

Draft as of 2025-12-16

Definitions for the getcareplansresponselm logical model.

Key Elements Table
Differential Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. getcareplansresponselm
Definition	Response message for GetCarePlans service contract
Short	GetCarePlans - Response
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. getcareplansresponselm.careunithsaid
Definition	Filtrering på PDL-enhet vilket motsvarar careUnitHSAId i healthcareProfessionalType.
Short	Filtrering på PDL-enhet vilket motsvarar careUnitHSAId i healthcareProfessionalType.
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. getcareplansresponselm.patientid
Definition	Id för patienten där fältet id sätts till patientens identifierare. Anges med 12 tecken utan avskiljare. Fältet type sätts till OID för typ av identifierare. 1) För personnummer ska Skatteverkets OID för personnummer (1.2.752.129.2.1.3.1) användas. 2) För samordningsnummer ska Skatteverkets OID för samordningsnummer (1.2.752.129.2.1.3.3) användas. 3) Tjänsteproducenter ska även stödja sökning på reservnummer med hjälp av att ange lokalt definierade OID’ar för reservnummer, exempelvis SLL rese...
Short	Id för patienten där fältet id sätts till patientens identifierare. Anges med 12 tecken utan avskiljare. Fältet type sätts till OID för typ av identifierare. 1) För personnummer ska Skatteverkets OID för personnummer (1.2.752.129.2.1.3.1) användas. 2) För samordningsnummer ska Skatteverkets OID för samordningsnummer (1.2.752.129.2.1.3.3) användas. 3) Tjänsteproducenter ska även stödja sökning på reservnummer med hjälp av att ange lokalt definierade OID’ar för reservnummer, exempelvis SLL rese...
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. getcareplansresponselm.patientid.id
Definition	unique id for the element within a resource (for internal references) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	xml:id (or equivalent in JSON)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
8. getcareplansresponselm.patientid.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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. 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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. getcareplansresponselm.patientid.value
Definition	The actual value
Short	Primitive value for string
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Max Length:	1048576
12. getcareplansresponselm.patientid.-id
Definition	Id för patient enligt ovan.
Short	Id för patient enligt ovan.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. getcareplansresponselm.patientid.type
Definition	OID enligt ovan.
Short	OID enligt ovan.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. getcareplansresponselm.dateperiod
Definition	Begränsar sökningen till det angivna intervallet. Begränsningen innebär att endast poster returneras där documentTime i svaret ligger inom sökintervallets start- och slutdatum. Notera att sökintervallet beskrivs som ett datumintervall. Vid jämförelse konverteras datapostens tidpunkter till datum.
Short	Begränsar sökningen till det angivna intervallet. Begränsningen innebär att endast poster returneras där documentTime i svaret ligger inom sökintervallets start- och slutdatum. Notera att sökintervallet beskrivs som ett datumintervall. Vid jämförelse konverteras datapostens tidpunkter till datum.
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. getcareplansresponselm.dateperiod.id
Definition	unique id for the element within a resource (for internal references) Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	xml:id (or equivalent in JSON)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
20. getcareplansresponselm.dateperiod.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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. 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()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
22. getcareplansresponselm.dateperiod.value
Definition	The actual value
Short	Primitive value for string
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Max Length:	1048576
24. getcareplansresponselm.dateperiod.start
Definition	Startdatum. Format ÅÅÅÅMMDD.
Short	Startdatum. Format ÅÅÅÅMMDD.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. getcareplansresponselm.dateperiod.end
Definition	Slutdatum. Format ÅÅÅÅMMDD.
Short	Slutdatum. Format ÅÅÅÅMMDD.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. getcareplansresponselm.sourcesystemhsaid
Definition	Begränsar sökningen till aktivitet som är skapad i det angivna källsystemet. Tjänsteproducenten förväntas enbart returnera poster som tillhör efterfrågat källsystem. Värdet på detta fält måste överensstämma med värdet på logicalAddress i anropets tekniska kuvertering (ex. SOAP-header). Det innebär i praktiken att aggregerande tjänster inte används när detta fält anges. Fältet är tvingande om careContactId angivits. Fältet är tvingande vid begäran på reservnummer.
Short	Begränsar sökningen till aktivitet som är skapad i det angivna källsystemet. Tjänsteproducenten förväntas enbart returnera poster som tillhör efterfrågat källsystem. Värdet på detta fält måste överensstämma med värdet på logicalAddress i anropets tekniska kuvertering (ex. SOAP-header). Det innebär i praktiken att aggregerande tjänster inte används när detta fält anges. Fältet är tvingande om careContactId angivits. Fältet är tvingande vid begäran på reservnummer.
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. getcareplansresponselm.carecontactid
Definition	Begränsar sökningen till den/de vårdkontakter vars id anges vilket matchar documentId i GetCareContactsResponse/careContact/careContactHeader Se test-case ”CareContactId Filter” som finns i SOAPui-projektet under test-suite/GetCarePlans
Short	Begränsar sökningen till den/de vårdkontakter vars id anges vilket matchar documentId i GetCareContactsResponse/careContact/careContactHeader Se test-case ”CareContactId Filter” som finns i SOAPui-projektet under test-suite/GetCarePlans
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. getcareplansresponselm
Definition	Response message for GetCarePlans service contract
Short	GetCarePlans - Response
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. getcareplansresponselm.careunithsaid
Definition	Filtrering på PDL-enhet vilket motsvarar careUnitHSAId i healthcareProfessionalType.
Short	Filtrering på PDL-enhet vilket motsvarar careUnitHSAId i healthcareProfessionalType.
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. getcareplansresponselm.patientid
Definition	Id för patienten där fältet id sätts till patientens identifierare. Anges med 12 tecken utan avskiljare. Fältet type sätts till OID för typ av identifierare. 1) För personnummer ska Skatteverkets OID för personnummer (1.2.752.129.2.1.3.1) användas. 2) För samordningsnummer ska Skatteverkets OID för samordningsnummer (1.2.752.129.2.1.3.3) användas. 3) Tjänsteproducenter ska även stödja sökning på reservnummer med hjälp av att ange lokalt definierade OID’ar för reservnummer, exempelvis SLL rese...
Short	Id för patienten där fältet id sätts till patientens identifierare. Anges med 12 tecken utan avskiljare. Fältet type sätts till OID för typ av identifierare. 1) För personnummer ska Skatteverkets OID för personnummer (1.2.752.129.2.1.3.1) användas. 2) För samordningsnummer ska Skatteverkets OID för samordningsnummer (1.2.752.129.2.1.3.3) användas. 3) Tjänsteproducenter ska även stödja sökning på reservnummer med hjälp av att ange lokalt definierade OID’ar för reservnummer, exempelvis SLL rese...
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
6. getcareplansresponselm.patientid.-id
Definition	Id för patient enligt ovan.
Short	Id för patient enligt ovan.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
8. getcareplansresponselm.patientid.type
Definition	OID enligt ovan.
Short	OID enligt ovan.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
10. getcareplansresponselm.dateperiod
Definition	Begränsar sökningen till det angivna intervallet. Begränsningen innebär att endast poster returneras där documentTime i svaret ligger inom sökintervallets start- och slutdatum. Notera att sökintervallet beskrivs som ett datumintervall. Vid jämförelse konverteras datapostens tidpunkter till datum.
Short	Begränsar sökningen till det angivna intervallet. Begränsningen innebär att endast poster returneras där documentTime i svaret ligger inom sökintervallets start- och slutdatum. Notera att sökintervallet beskrivs som ett datumintervall. Vid jämförelse konverteras datapostens tidpunkter till datum.
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
12. getcareplansresponselm.dateperiod.start
Definition	Startdatum. Format ÅÅÅÅMMDD.
Short	Startdatum. Format ÅÅÅÅMMDD.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. getcareplansresponselm.dateperiod.end
Definition	Slutdatum. Format ÅÅÅÅMMDD.
Short	Slutdatum. Format ÅÅÅÅMMDD.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. getcareplansresponselm.sourcesystemhsaid
Definition	Begränsar sökningen till aktivitet som är skapad i det angivna källsystemet. Tjänsteproducenten förväntas enbart returnera poster som tillhör efterfrågat källsystem. Värdet på detta fält måste överensstämma med värdet på logicalAddress i anropets tekniska kuvertering (ex. SOAP-header). Det innebär i praktiken att aggregerande tjänster inte används när detta fält anges. Fältet är tvingande om careContactId angivits. Fältet är tvingande vid begäran på reservnummer.
Short	Begränsar sökningen till aktivitet som är skapad i det angivna källsystemet. Tjänsteproducenten förväntas enbart returnera poster som tillhör efterfrågat källsystem. Värdet på detta fält måste överensstämma med värdet på logicalAddress i anropets tekniska kuvertering (ex. SOAP-header). Det innebär i praktiken att aggregerande tjänster inte används när detta fält anges. Fältet är tvingande om careContactId angivits. Fältet är tvingande vid begäran på reservnummer.
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
18. getcareplansresponselm.carecontactid
Definition	Begränsar sökningen till den/de vårdkontakter vars id anges vilket matchar documentId i GetCareContactsResponse/careContact/careContactHeader Se test-case ”CareContactId Filter” som finns i SOAPui-projektet under test-suite/GetCarePlans
Short	Begränsar sökningen till den/de vårdkontakter vars id anges vilket matchar documentId i GetCareContactsResponse/careContact/careContactHeader Se test-case ”CareContactId Filter” som finns i SOAPui-projektet under test-suite/GetCarePlans
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be foundhere

0. getcareplansresponselm
Definition	Response message for GetCarePlans service contract
Short	GetCarePlans - Response
Control	0..*
Is Modifier	false
Logical Model	Instances of this logical model are not marked to be the target of a Reference
2. getcareplansresponselm.careunithsaid
Definition	Filtrering på PDL-enhet vilket motsvarar careUnitHSAId i healthcareProfessionalType.
Short	Filtrering på PDL-enhet vilket motsvarar careUnitHSAId i healthcareProfessionalType.
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
4. getcareplansresponselm.patientid
Definition	Id för patienten där fältet id sätts till patientens identifierare. Anges med 12 tecken utan avskiljare. Fältet type sätts till OID för typ av identifierare. 1) För personnummer ska Skatteverkets OID för personnummer (1.2.752.129.2.1.3.1) användas. 2) För samordningsnummer ska Skatteverkets OID för samordningsnummer (1.2.752.129.2.1.3.3) användas. 3) Tjänsteproducenter ska även stödja sökning på reservnummer med hjälp av att ange lokalt definierade OID’ar för reservnummer, exempelvis SLL rese...
Short	Id för patienten där fältet id sätts till patientens identifierare. Anges med 12 tecken utan avskiljare. Fältet type sätts till OID för typ av identifierare. 1) För personnummer ska Skatteverkets OID för personnummer (1.2.752.129.2.1.3.1) användas. 2) För samordningsnummer ska Skatteverkets OID för samordningsnummer (1.2.752.129.2.1.3.3) användas. 3) Tjänsteproducenter ska även stödja sökning på reservnummer med hjälp av att ange lokalt definierade OID’ar för reservnummer, exempelvis SLL rese...
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
6. getcareplansresponselm.patientid.id
Definition	unique id for the element within a resource (for internal references)
Short	xml:id (or equivalent in JSON)
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
8. getcareplansresponselm.patientid.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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()`)
10. getcareplansresponselm.patientid.value
Definition	The actual value
Short	Primitive value for string
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Max Length:	1048576
12. getcareplansresponselm.patientid.-id
Definition	Id för patient enligt ovan.
Short	Id för patient enligt ovan.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
14. getcareplansresponselm.patientid.type
Definition	OID enligt ovan.
Short	OID enligt ovan.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
16. getcareplansresponselm.dateperiod
Definition	Begränsar sökningen till det angivna intervallet. Begränsningen innebär att endast poster returneras där documentTime i svaret ligger inom sökintervallets start- och slutdatum. Notera att sökintervallet beskrivs som ett datumintervall. Vid jämförelse konverteras datapostens tidpunkter till datum.
Short	Begränsar sökningen till det angivna intervallet. Begränsningen innebär att endast poster returneras där documentTime i svaret ligger inom sökintervallets start- och slutdatum. Notera att sökintervallet beskrivs som ett datumintervall. Vid jämförelse konverteras datapostens tidpunkter till datum.
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. getcareplansresponselm.dateperiod.id
Definition	unique id for the element within a resource (for internal references)
Short	xml:id (or equivalent in JSON)
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
20. getcareplansresponselm.dateperiod.extension
Definition	May be used to represent additional information that is not part of the basic definition of the resource. 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()`)
22. getcareplansresponselm.dateperiod.value
Definition	The actual value
Short	Primitive value for string
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Max Length:	1048576
24. getcareplansresponselm.dateperiod.start
Definition	Startdatum. Format ÅÅÅÅMMDD.
Short	Startdatum. Format ÅÅÅÅMMDD.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
26. getcareplansresponselm.dateperiod.end
Definition	Slutdatum. Format ÅÅÅÅMMDD.
Short	Slutdatum. Format ÅÅÅÅMMDD.
Control	1..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
28. getcareplansresponselm.sourcesystemhsaid
Definition	Begränsar sökningen till aktivitet som är skapad i det angivna källsystemet. Tjänsteproducenten förväntas enbart returnera poster som tillhör efterfrågat källsystem. Värdet på detta fält måste överensstämma med värdet på logicalAddress i anropets tekniska kuvertering (ex. SOAP-header). Det innebär i praktiken att aggregerande tjänster inte används när detta fält anges. Fältet är tvingande om careContactId angivits. Fältet är tvingande vid begäran på reservnummer.
Short	Begränsar sökningen till aktivitet som är skapad i det angivna källsystemet. Tjänsteproducenten förväntas enbart returnera poster som tillhör efterfrågat källsystem. Värdet på detta fält måste överensstämma med värdet på logicalAddress i anropets tekniska kuvertering (ex. SOAP-header). Det innebär i praktiken att aggregerande tjänster inte används när detta fält anges. Fältet är tvingande om careContactId angivits. Fältet är tvingande vid begäran på reservnummer.
Control	0..1
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
30. getcareplansresponselm.carecontactid
Definition	Begränsar sökningen till den/de vårdkontakter vars id anges vilket matchar documentId i GetCareContactsResponse/careContact/careContactHeader Se test-case ”CareContactId Filter” som finns i SOAPui-projektet under test-suite/GetCarePlans
Short	Begränsar sökningen till den/de vårdkontakter vars id anges vilket matchar documentId i GetCareContactsResponse/careContact/careContactHeader Se test-case ”CareContactId Filter” som finns i SOAPui-projektet under test-suite/GetCarePlans
Control	0..*
Type	string
Primitive Value	This primitive element may be present, or absent, or replaced by an extension