Capability Statement
REST Capabilities Server
| Mode | Server | Documentation | See implementation guide for details |
Security
| Cors | True |
| Service | OAuth |
Resource Interactions
| Resource Type | Profile | Read | Vread | Update | Delete | Create | SearchType | ConditionalCreate | ConditionalUpdate | ConditionalDelete |
|---|---|---|---|---|---|---|---|---|---|---|
| CarePlan | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| Observation | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| Patient | Finnish PHR Patient profile | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported | |
| MedicationStatement | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | 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 | ||
| Consent | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Not Supported | NotSupported |
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 |
| _security | token | If the viewing the resource is restricted. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| date | date | Time period the plan covers | Supported |
| patient | reference | Who care plan is for | Supported |
Observation
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| _security | token | If the viewing the resource is restricted. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | 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 i... | 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 |
Patient
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
MedicationStatement
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| _security | token | If the viewing the resource is restricted. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| patient | reference | The identity of a patient to list statements for, mandatory search parameter | Supported |
| effective | date | Date when patient was taking (or not taking) the medication | Supported |
| identifier | token | Return statements with this external identifier. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| code | token | Return statements of this medication code. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| status | token | Return statements that match the given status. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
MedicationAdministration
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| _security | token | If the viewing the resource is restricted. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | 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... | 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 |
QuestionnaireResponse
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| _security | token | If the viewing the resource is restricted. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | 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 |
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 |
| status | token | The current status of the structure definition. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
CodeSystem
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| url | uri | The uri that identifies the code system | Supported |
Consent
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | Logical id of this artifact | Supported |
| patient | reference | Who the consent applies to, mandatory search parameter | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| category | token | Classification of the consent statement - for indexing/retrieval. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |
| identifier | token | Identifier for this record (external references). The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]. | Supported |