ConditionHealthIssueSe

Introduction

The ConditionHealthIssueSe profile serves as a data container for transmitting information about a health issue, detailing a patient's process through healthcare for one or multiple related conditions.

This profile is derived from the Condition resource in FHIR R4 edition and tailored specifically for the Swedish healthcare market as the supported SNOMED CT code system is defined for the Swedish market.

Intended Use

This API is designed to retrieve basic information of a patient's active pregnancy, primarily for purposes like linking QuestionnaireResponses. It is advised against presenting this data directly to end-users, hence the specific condition names are not currently exposed and only the code name is returned. Furthermore, storing any fetched information in an external system is discouraged due to the temporary nature of identifier values, which may change (for instance, if a condition is merged with another condition).

The intended use for reading data with this API is in first hand that the API is applied for direct access and should not be used to transfer data between caregivers. If it should be used for "data copying" between care providers, patient consent must be handled outside the API.

Specific Rules and Limitations

Type Description
Limitation It is only possible to fetch health issues in status 'Active'.
Limitation It is only possible to request health issues with the code '118185001' (Pregnancy) of the SNOMED CT code system.
Rule The data retrieved from this API must not be stored in the external system due to the temporary nature of identifier values.
Rule The data retrieved from this API should be used exclusively for backend processing, such as linking QuestionnaireResponses by ID. The data must not be presented to end users. If the data is to be presented, the consumer of the API is responsible for making sure data retrieved is filtered in compliance with laws and regulations prior to presenting it to any end-users.

Profile Overview

ConditionHealthIssueSe

idΣ0..1string
metaΣ0..0Meta
implicitRulesΣ ?!0..0uri
language0..0codeBinding
text0..0Narrative
contained0..0Resource
participantI0..*Extension(Complex)
modifierExtension?! I0..0Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..0CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..0Period
assignerΣ I0..0Reference(Organization)
id0..0string
extensionI0..0Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..1string
userSelectedΣ0..0boolean
textΣ0..0string
verificationStatusΣ ?! I0..0CodeableConceptBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemΣ1..1uriFixed Value
versionΣ0..0string
codeΣ1..1codeFixed Value
displayΣ1..1stringFixed Value
userSelectedΣ0..0boolean
textΣ0..0string
severity0..0CodeableConceptBinding
id0..0string
extensionI0..0Extension
id0..0string
extensionI0..0Extension
systemΣ1..1uri
versionΣ0..0string
codeΣ1..1code
displayΣ0..0string
userSelectedΣ0..0boolean
textΣ0..1string
bodySiteΣ0..0CodeableConcept
id0..1string
extensionI0..*Extension
referenceΣ I0..0string
typeΣ0..0uriBinding
displayΣ0..0string
encounterΣ I0..0Reference(Encounter)
recordedDateΣ0..0dateTime
recorderΣ I0..0Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
asserterΣ I0..0Reference(Practitioner | PractitionerRole | Patient | RelatedPerson)
note0..0Annotation

Statuses

FHIR status Status in COSMIC
Active Open

Note that the other statuses are not mapped as they are not supported in the API.

Versions

COS version Profile version Required COSMIC version Date Description
4.4.0 1.0.0 4.0.0 July 2024 Initial version, support for GET.

Supported Operations

HTTP Methods

Method Description Scope
GET Fetch conditions of type 'Pregnancy' in status 'Active' by patient. Provide at least one of the following minimum scopes: user/Condtion.read OR system/Condtion.read OR patient/Condtion.read

Query Operations

Search Parameters

Query parameter Format Mandatory/Optional Description
Subject.identifier Or, Subject Reference Mandatory The identifier or the id of the patient with whom the condition is associated.
Code Token Mandatory The code and the system of the condition name. Currently, only the Code '118185001' (Pregnancy) from the CodeSystem http://snomed.info/sct/45991000052106 is supported.
Category Token Mandatory Only the Code 'problem-list-item' from the CodeSystem http://terminology.hl7.org/CodeSystem/condition-category is supported, as the endpoint supports fetching only the ConditionHealthIssueSe profiles or the Health Issues.
_include String Optional The supported SearchInclude operation is Condition:subject.

Supported Queries

Search [baseURL]/Condition?subject.identifier=urn:oid:1.2.752.129.2.1.3.1|197305281904&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

Search [baseURL]/Condition?subject.identifier=urn:oid:1.2.752.129.2.1.3.1|197305281904&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item&_include=Condition:subject

Search [baseURL]/Condition?subject=Patient/1071&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

Search [baseURL]/Condition?subject=1071&code=http://snomed.info/sct/45991000052106|118185001&category=http://terminology.hl7.org/CodeSystem/condition-category|problem-list-item

Supported SearchInclude Operations

  1. Condition:subject

Error Codes

Scenario Error code Description
When a value is not supplied for the 'Subject.identifier' parameter. 400 Bad Request Invalid request: The FHIR endpoint on this server does not know how to handle GET operation[Condition] with parameters [[code, category]]
When a value is not supplied for the 'Code' parameter. 400 Bad Request Invalid request: The FHIR endpoint on this server does not know how to handle GET operation[Condition] with parameters [[subject, category]]
When a value is not supplied for the 'Category' parameter. 400 Bad Request Invalid request: The FHIR endpoint on this server does not know how to handle GET operation[Condition] with parameters [[code, subject]]
When the supplied 'Code.Code' value is not '118185001' and the 'Code.System' is not http://snomed.info/sct/45991000052106. 400 Bad Request Invalid search parameters: The acceptable value for 'Code.code' is '118185001', and the correct 'Code.system' is 'http://snomed.info/sct/45991000052106'.
When the supplied 'Category.Code' value is not 'problem-list-item' and the 'Category.System' is not http://terminology.hl7.org/CodeSystem/condition-category 400 Bad Request Invalid search parameters: The acceptable value for 'Category.code' is 'problem-list-item', and the correct 'Category.system' is 'http://terminology.hl7.org/CodeSystem/condition-category'.
If a patient doesn't exist in Cosmic for the supplied patient identification number. 404 Not Found Patient Not found for the given identifier.
If a scope other than the allowed minimum scopes: user/Condtion.read OR system/Condtion.read OR patient/Condtion.read is supplied. 403 Forbidden Access is denied.

For common codes, refer to Error handling section.