{
"description": "The capability statement for Kanta PHR service client software acceptance testing environment",
"_filename": "capabilitystatementATR4.json",
"package_name": "fi.digious.kanta.test",
"format": [ "json" ],
"date": "2021-11-25",
"publisher": "Kela",
"fhirVersion": "4.0.1",
"name": "Finnish PHR's capability statement for acceptance testing R4",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"title": null,
"package_version": "0.0.1-preview-1",
"status": "draft",
"id": "8d3beaf2-a6ba-48ff-9b35-5305e042f6ce",
"kind": "requirements",
"url": "http://phr.kanta.fi/capabilitystatementATR4",
"software": {
"name": "Omatietovaranto",
"version": "1.1",
"releaseDate": "2021-11-25"
},
"version": "1.1.0",
"contact": [ {
"name": "kantakehitys@kanta.fi"
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "CarePlan",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update",
"documentation": "SupportingInfo isn't validated with update"
}, {
"code": "delete"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "search-type"
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "CarePlan.id",
"documentation": "Logical id of this artifact"
}, {
"name": "_lastUpdated",
"type": "date",
"definition": "CarePlan.meta.lastUpdated",
"documentation": "When the resource version last changed"
}, {
"name": "date",
"type": "date",
"definition": "CarePlan.period",
"documentation": "Time period the plan covers"
}, {
"name": "patient",
"type": "reference",
"definition": "CarePlan.subject",
"documentation": "Who care plan is for"
}, {
"name": "status",
"type": "token",
"definition": "CarePlan.status",
"documentation": "Status of the plan"
}, {
"name": "identifier",
"type": "token",
"definition": "CarePlan.identfier",
"documentation": "Return careplans with this external identifier"
}, {
"name": "category",
"type": "token",
"definition": "CarePlan.category",
"documentation": "The category for a particular careplan"
}, {
"name": "supporting-info",
"type": "reference",
"definition": "CarePlan.supportingInfo",
"documentation": "Reference to supporting info"
}, {
"name": "_total",
"type": "special",
"definition": "Total count of resources",
"documentation": "Total count of resources"
} ],
"referencePolicy": [ "literal", "enforced", "local" ],
"conditionalCreate": true,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "Observation.id",
"documentation": "Logical id of this artifact"
}, {
"name": "_lastUpdated",
"type": "date",
"definition": "Observation.meta.lastUpdated",
"documentation": "When the resource version last changed"
}, {
"name": "date",
"type": "date",
"definition": "Observation.effective[x]",
"documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period. AND operator is supported."
}, {
"name": "patient",
"type": "reference",
"definition": "Observation.subject",
"documentation": "The patient that the observation is about, mandatory search parameter"
}, {
"name": "code",
"type": "token",
"definition": "Observation.code",
"documentation": "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."
}, {
"name": "identifier",
"type": "token",
"definition": "Observation.identifier",
"documentation": "The unique id for a particular observation. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]."
}, {
"name": "category",
"type": "token",
"definition": "Observation.category",
"documentation": "The classification of the type of observation. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]."
}, {
"name": "_total",
"type": "special",
"definition": "Total count of resources",
"documentation": "Total count of resources"
} ],
"conditionalUpdate": false,
"referencePolicy": [ "literal", "enforced", "local" ],
"readHistory": true,
"type": "Observation",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "delete",
"documentation": "Only the source of the resource or Omakanta can delete resources"
}, {
"code": "search-type"
} ],
"updateCreate": false,
"conditionalCreate": true,
"versioning": "versioned-update",
"conditionalDelete": "not-supported"
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "Patient.id",
"documentation": "Logical id of this artifact"
} ],
"conditionalUpdate": false,
"referencePolicy": [ "literal", "enforced", "local" ],
"readHistory": true,
"type": "Patient",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "search-type"
} ],
"updateCreate": true,
"conditionalCreate": true,
"versioning": "versioned-update",
"conditionalDelete": "not-supported"
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "MedicationAdministration.id",
"documentation": "Logical id of this artifact"
}, {
"name": "_lastUpdated",
"type": "date",
"definition": "MedicationAdministration.meta.lastUpdated",
"documentation": "When the resource version last changed"
}, {
"name": "effective-time",
"type": "date",
"definition": "MedicationAdministration.effectiveTime[x]",
"documentation": "Date administration happened (or did not happen)"
}, {
"name": "patient",
"type": "reference",
"definition": "MedicationAdministration.patient",
"documentation": "The identity of a patient to list administrations for, mandatory search parameter"
}, {
"name": "identifier",
"type": "token",
"definition": "MedicationAdministration.identifier",
"documentation": "Return administrations with this external identifier. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]."
}, {
"name": "code",
"type": "token",
"definition": "MedicationAdministration.medication[x]",
"documentation": "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."
}, {
"name": "_total",
"type": "special",
"definition": "Total count of resources",
"documentation": "Total count of resources"
} ],
"conditionalUpdate": false,
"referencePolicy": [ "literal", "enforced", "local" ],
"readHistory": true,
"type": "MedicationAdministration",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "delete",
"documentation": "Only the source of the resource or Omakanta can delete resources"
}, {
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
} ],
"updateCreate": false,
"conditionalCreate": true,
"versioning": "versioned-update",
"conditionalDelete": "not-supported"
}, {
"type": "Questionnaire",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "create",
"documentation": "Conditional create allow only identifier parameter"
}, {
"code": "search-type"
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "Questionnaire.id",
"documentation": "Logical id of this artifact"
}, {
"name": "_lastUpdated",
"type": "date",
"definition": "Questionnaire.meta.lastUpdated",
"documentation": "When the resource version last changed"
}, {
"name": "code",
"type": "token",
"definition": "Questionnaire.item.code",
"documentation": "A code that corresponds to the questionnaire or one of its groups. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]."
}, {
"name": "identifier",
"type": "token",
"definition": "Questionnaire.identifier",
"documentation": "An identifier for the questionnaire. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]."
}, {
"name": "url",
"type": "uri",
"definition": "Questionnaire.url",
"documentation": "The logical URL for the questionnaire"
}, {
"name": "_total",
"type": "special",
"definition": "Total count of resources",
"documentation": "Total count of resources"
} ],
"referencePolicy": [ "literal", "enforced", "local" ],
"conditionalCreate": true,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"type": "QuestionnaireResponse",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "delete"
}, {
"code": "create",
"documentation": "Conditional create allow only identifier parameter"
}, {
"code": "search-type"
} ],
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "QuestionnaireResponse.id",
"documentation": "Logical id of this artifact"
}, {
"name": "_lastUpdated",
"type": "date",
"definition": "QuestionnaireResponse.meta.lastUpdated",
"documentation": "When the resource version last changed"
}, {
"name": "questionnaire",
"type": "reference",
"definition": "QuestionnaireResponse.questionnaire",
"documentation": "The questionnaire the answers are provided for"
}, {
"name": "patient",
"type": "reference",
"definition": "QuestionnaireResponse.subject",
"documentation": "The patient that is the subject of the questionnaire, mandatory search parameter"
}, {
"name": "authored",
"type": "date",
"definition": "\tQuestionnaireResponse.authored",
"documentation": "When the questionnaire was authored"
}, {
"name": "identifier",
"type": "token",
"definition": "QuestionnaireResponse.identifier",
"documentation": "The unique identifier for the questionnaire response. The following syntaxes are supported: [parameter]=[code] and [parameter]=[system]|[code]."
}, {
"name": "_total",
"type": "special",
"definition": "Total count of resources",
"documentation": "Total count of resources"
} ],
"referencePolicy": [ "literal", "enforced", "local" ],
"conditionalCreate": true,
"conditionalDelete": "not-supported",
"conditionalUpdate": false
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "ValueSet.id",
"documentation": "Logical id of this artifact"
}, {
"name": "url",
"type": "uri",
"definition": "ValueSet.url",
"documentation": "The logical URL for the value set"
} ],
"conditionalUpdate": false,
"referencePolicy": [ "literal", "enforced", "local" ],
"readHistory": true,
"type": "ValueSet",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
} ],
"updateCreate": false,
"conditionalCreate": true,
"versioning": "versioned-update",
"conditionalDelete": "not-supported"
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "StructureDefinition.id",
"documentation": "Logical id of this artifact"
}, {
"name": "url",
"type": "uri",
"definition": "StructureDefinition.url",
"documentation": "The uri that identifies the structure definition"
} ],
"conditionalUpdate": false,
"referencePolicy": [ "literal", "enforced", "local" ],
"readHistory": true,
"type": "StructureDefinition",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
} ],
"updateCreate": false,
"conditionalCreate": true,
"versioning": "versioned-update",
"conditionalDelete": "not-supported"
}, {
"searchParam": [ {
"name": "_id",
"type": "token",
"definition": "CodeSystem.id",
"documentation": "Logical id of this artifact"
}, {
"name": "url",
"type": "uri",
"definition": "CodeSystem.url",
"documentation": "The uri that identifies the code system"
} ],
"conditionalUpdate": false,
"referencePolicy": [ "literal", "enforced", "local" ],
"readHistory": true,
"type": "CodeSystem",
"interaction": [ {
"code": "read"
}, {
"code": "vread"
}, {
"code": "update"
}, {
"code": "create",
"documentation": "Conditional create allows only the use of identifier as condition"
}, {
"code": "search-type",
"documentation": "Implemented per the specification (or Insert other doco here)"
} ],
"updateCreate": false,
"conditionalCreate": true,
"versioning": "versioned-update",
"conditionalDelete": "not-supported"
} ],
"security": {
"cors": true,
"service": [ {
"text": "OAuth"
} ],
"description": "The usage of OAuth 2.0 with Finnish PHR can be found at kanta.fi"
},
"documentation": "See implementation guide for details"
} ]
}