Capability Statement
REST Capabilities Server
| Mode | Server |
|---|---|
| Documentation | |
| Transaction | Supported Transaction is supported in Bundle. Read more about bundle (pdf) |
| Batch | Supported Trasnaction is supported in Bundle. Read more about bundle (pdf) |
Security
| Cors | True |
|---|---|
| Service | OAuth |
| Description | The usage of OAuth 2.0 with Finnish PHR can be found at kanta.fi or from authorization guide (pdf). In addition to OAuth 2.0, a DVV service certificates for wellbeing applications is used. Read more about service certificates for wellbeing applications (dvv.fi) |
Resource Interactions
| Resource Type | Supported Profiles | Read | Vread | Update | Delete | Create | SearchType | ConditionalCreate | ConditionalUpdate | ConditionalDelete |
|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| Observation | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| Patient | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | ||
| MedicationAdministration | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| Questionnaire | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| QuestionnaireResponse | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| ValueSet | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | ||
| StructureDefinition | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | ||
| CodeSystem | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported |
Operations per resource type
CarePlan
No operations are stated for this resource type
Observation
| Operation | Reference | Documentation | Level |
|---|---|---|---|
| readWithIncludes | ReadWithIncludes | Extension for read operation | Supported |
Patient
No operations are stated for this resource type
MedicationAdministration
No operations are stated for this resource type
Questionnaire
No operations are stated for this resource type
QuestionnaireResponse
No operations are stated for this resource type
ValueSet
No operations are stated for this resource type
StructureDefinition
No operations are stated for this resource type
CodeSystem
No operations are stated for this resource type
Search Parameters per resource type
CarePlan
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| date | date | Time period the plan covers | Supported |
| patient | reference | Who care plan is for | Supported |
| status | token | Status of the plan | Supported |
| identifier | token | Return careplans with this external identifier | Supported |
| category | token | The category for a particular careplan | Supported |
| supporting-info | reference | Reference to supporting info | Supported |
| _total | special | Total count of resources | Supported |
Observation
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| date | date | Obtained date/time. If the obtained element is a period, a date that falls in the period. AND operator is supported. | Supported |
| patient | reference | The patient that the observation is about, mandatory search parameter | Supported |
| code | token | The code of the observation type. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. OR operator is supported. If searching with multiple codes and code.system isn't given, default codesystem http://loinc.org will be used. | Supported |
| identifier | token | The unique id for a particular observation. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| category | token | The classification of the type of observation. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| _total | special | Total count of resources | Supported |
Patient
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
MedicationAdministration
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| effective-time | date | Date administration happened (or did not happen) | Supported |
| patient | reference | The identity of a patient to list administrations for, mandatory search parameter | Supported |
| identifier | token | Return administrations with this external identifier. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| code | token | Return administrations of this medication code. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. OR operator is supported. If searching with multiple codes and code.system isn't given, default codesystem http://phr.kanta.fi/CodeSystem/fiphr-cs-insulincode will be used. | Supported |
| _total | special | Total count of resources | Supported |
Questionnaire
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| code | token | A code that corresponds to the questionnaire or one of its groups. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| identifier | token | An identifier for the questionnaire. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| url | uri | The logical URL for the questionnaire | Supported |
| _total | special | Total count of resources | Supported |
QuestionnaireResponse
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| questionnaire | reference | The questionnaire the answers are provided for | Supported |
| patient | reference | The patient that is the subject of the questionnaire, mandatory search parameter | Supported |
| authored | date | When the questionnaire was authored | Supported |
| identifier | token | The unique identifier for the questionnaire response. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| _total | special | Total count of resources | Supported |
ValueSet
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| url | uri | The logical URL for the value set | Supported |
StructureDefinition
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| url | uri | The uri that identifies the structure definition | Supported |
CodeSystem
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| url | uri | The uri that identifies the code system | Supported |