{
"description": null,
"_filename": "ImplementationGuide-se.electronichealth.fhir.ppdr.r5.json",
"package_name": "se.electronichealth.fhir.ppdr.r5",
"definition": {
"page": {
"name": "toc.html",
"page": [ ],
"title": "Table of Contents",
"sourceUrl": "toc.html",
"generation": "html"
},
"resource": [ {
"name": "Aktiviteter som företrädarskap innefattar",
"isExample": false,
"reference": {
"reference": "ValueSet/ps-permission-actions"
},
"description": "Includes activities which can be permitted to be performed on behalf of someone else."
}, {
"name": "AuthorizationTemplate1",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/NDIAuthorizationTemplate" ],
"isExample": true,
"reference": {
"reference": "DocumentReference/15cdd584-cd02-4fa9-98cd-6482f6f2f564"
},
"description": "Åtkomst till min hälsadata"
}, {
"name": "AuthorizeReadLabData",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/proxy-permission-ps" ],
"isExample": true,
"reference": {
"reference": "Permission/4165f483-357b-4e0c-b7e7-d8f1ed77fc23"
}
}, {
"name": "GetConsent-RestrictionsAndOrganizationsOfPatient-ResponseBody",
"isExample": true,
"reference": {
"reference": "Bundle/1869f6bb-38c5-4f67-b5fc-42d0f15cbc59"
},
"description": "Search result from GET Consent?patient&_include=Consent:data:Organization"
}, {
"name": "GetConsent-RestrictionsAndRelatedPersonsOfPatient-ResponseBody",
"isExample": true,
"reference": {
"reference": "Bundle/e813d64f-d564-416f-ae6c-66e6c2472494"
},
"description": "Search result from GET Consent?patient&_include=Consent:grantee:RelatedPerson"
}, {
"name": "GetConsent-RestrictionsOfPatient-ResponseBody",
"isExample": true,
"reference": {
"reference": "Bundle/c7b6ba5f-077b-4dc7-893a-14dffc2f0f05"
},
"description": "Search result from GET Consent?patient"
}, {
"name": "GetPermission response body with invalid system ID message",
"isExample": true,
"reference": {
"reference": "OperationOutcome/64a5d5d1-1344-4d82-aaf8-ac4dcb71a808"
},
"description": "Example of response body with an OperationOutcome of failed ProxyPermission query because of invalid format of identifier system"
}, {
"name": "GetSignatureRequest",
"isExample": false,
"reference": {
"reference": "OperationDefinition/GetSignatureRequest"
}
}, {
"name": "GetSignatureRequest response body with invalid idP code message",
"isExample": true,
"reference": {
"reference": "OperationOutcome/749a2955-7518-4045-a389-d57d953c2e24"
},
"description": "Example of response body with an OperationOutcome of failed RequestSAMLSignature operation because of invalid idP code"
}, {
"name": "GetSignatureRequest response body with unknown logical ID message",
"isExample": true,
"reference": {
"reference": "OperationOutcome/c98d0d69-ea3c-4e7c-b0d5-f521defe1ef0"
},
"description": "Example of response body with an OperationOutcome of failed RequestSAMLSignature operation because of unknown logical ID of Consent"
}, {
"name": "GetSignatureRequest-BankId-RequestBody",
"isExample": true,
"reference": {
"reference": "Parameters/GetSignatureRequest-BankId-RequestBody"
}
}, {
"name": "GetSignatureRequest-Success-ResponseBody",
"isExample": true,
"reference": {
"reference": "Parameters/3dbc6217-82c1-486a-93ee-1772cb8cd392"
}
}, {
"name": "IdentifiedLegalGuardian",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/related-person-re" ],
"isExample": true,
"reference": {
"reference": "RelatedPerson/1639ce1a-0509-44d7-8bfd-20332fb4ac17"
}
}, {
"name": "Identitetsleverantörer för signering",
"isExample": false,
"reference": {
"reference": "ValueSet/poa-signing-identity-providers"
},
"description": "Includes identity providers which can be used for signing."
}, {
"name": "InactivateAuthorizationForReadingLabData",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/proxy-permission-ps" ],
"isExample": true,
"reference": {
"reference": "Permission/514cea28-1fb6-4762-99eb-b7f5de8e4711"
}
}, {
"name": "LegalGuardian",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/related-person-re" ],
"isExample": true,
"reference": {
"reference": "RelatedPerson/11249d0b-fd94-4a0e-8347-3cb253b1a4a7"
}
}, {
"name": "NDI authorization error codes",
"isExample": false,
"reference": {
"reference": "ValueSet/ndi-error-codes-authorization"
}
}, {
"name": "NDI restriction error codes",
"isExample": false,
"reference": {
"reference": "ValueSet/ndi-error-codes-restriction"
}
}, {
"name": "NDIAuthorizationTemplate",
"isExample": false,
"reference": {
"reference": "StructureDefinition/NDIAuthorizationTemplate"
}
}, {
"name": "OptOut",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" ],
"isExample": true,
"reference": {
"reference": "Consent/39565af2-9ea6-4504-a1f0-857380ddfedd"
}
}, {
"name": "OrganizationDataAccess",
"isExample": false,
"reference": {
"reference": "StructureDefinition/organization-data-access"
},
"description": "Profile for organization, organizational unit or EU country in a data access domain."
}, {
"name": "PatientDataAccess",
"isExample": false,
"reference": {
"reference": "StructureDefinition/patient-data-access"
},
"description": "Profile representing a patient in a data access domain."
}, {
"name": "Permission Data Document Type (PS)",
"isExample": false,
"reference": {
"reference": "StructureDefinition/permission-data-document-type-ps"
},
"description": "Extension for Permission rule data to express type of data."
}, {
"name": "PermissionActorParameter",
"isExample": false,
"reference": {
"reference": "SearchParameter/PermissionActorParameter"
},
"description": "Search parameter for querying ProxyPermissions based on RelatedPerson rule.activity.actor identifier."
}, {
"name": "PermissionAsserterParameter",
"isExample": false,
"reference": {
"reference": "SearchParameter/PermissionAsserterParameter"
},
"description": "Search parameter for querying ProxyPermissions based on Patient asserter identifier."
}, {
"name": "PermittedLegalGuardian",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/proxy-permission-ps" ],
"isExample": true,
"reference": {
"reference": "Permission/29a546c9-5d32-498c-9e3a-cb9cc5b69a06"
}
}, {
"name": "Power of Attorney (POA)",
"isExample": false,
"reference": {
"reference": "StructureDefinition/power-of-attorney-poa"
}
}, {
"name": "power-of-attorney-form-filler-actor-poa",
"isExample": false,
"reference": {
"reference": "ActorDefinition/power-of-attorney-form-filler-actor-poa"
},
"description": "The Power of Attorney Form Filler may retrieve and fill in power of attorney forms as well as request a signing request."
}, {
"name": "power-of-attorney-form-filler-capabilities-poa",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/power-of-attorney-form-filler-capabilities-poa"
},
"description": "Capabilities of a Power of Attorney Form Filler."
}, {
"name": "power-of-attorney-source-actor-poa",
"isExample": false,
"reference": {
"reference": "ActorDefinition/power-of-attorney-source-actor-poa"
},
"description": "The Power of Attorney Source can manage powers of attorney as well as produce signing requests for them."
}, {
"name": "power-of-attorney-source-capabilities-poa",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/power-of-attorney-source-capabilities-poa"
},
"description": "Capabilities of a Power of Attorney Source."
}, {
"name": "power-of-attorney-template-manager-actor-poa",
"isExample": false,
"reference": {
"reference": "ActorDefinition/power-of-attorney-template-manager-actor-poa"
},
"description": "The Power Of Attorney Template Manager can make available power of attorney templates."
}, {
"name": "power-of-attorney-template-manager-capabilities-poa",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/power-of-attorney-template-manager-capabilities-poa"
},
"description": "Capabilities of a Power of Attorney Template Manager."
}, {
"name": "ProcessRestriction",
"isExample": false,
"reference": {
"reference": "OperationDefinition/ProcessRestriction"
},
"description": "Processes a restriction Bundle containing one ore more Consents and their related resources."
}, {
"name": "ProcessRestriction response body with failed processing outcome",
"isExample": true,
"reference": {
"reference": "OperationOutcome/83f4e61e-673f-41e7-8624-20feef72ed11"
},
"description": "Example of response body with an OperationOutcome of failed restriction processing transaction"
}, {
"name": "ProcessRestriction response body with invalid cardinality message",
"isExample": true,
"reference": {
"reference": "OperationOutcome/70339ce6-01c1-4486-8040-5e9a4eef2eee"
},
"description": "Example of response body with an OperationOutcome of failed restriction transaction because of invalid format of identifier system"
}, {
"name": "ProcessRestriction response body with invalid system ID message",
"isExample": true,
"reference": {
"reference": "OperationOutcome/0e1f84be-2595-4d30-b302-5bb6ee352ef7"
},
"description": "Example of response body with an OperationOutcome of failed restriction transaction because of invalid format of identifier system"
}, {
"name": "ProcessRestriction response body with success message and returned IDs",
"isExample": true,
"reference": {
"reference": "Parameters/9ccf26eb-9b76-421c-b63c-bb70b6deac54"
},
"description": "Example of response body as Parameters with an OperationOutcome of successful restriction processing transaction and references to created Restrictions"
}, {
"name": "ProcessRestriction-OptOut-RequestBody",
"isExample": true,
"reference": {
"reference": "Parameters/ProcessRestriction-OptOut-RequestBody"
}
}, {
"name": "ProcessRestriction-RestrictLegalGuardian-RequestBody",
"isExample": true,
"reference": {
"reference": "Parameters/ProcessRestriction-RestrictLegalGuardian-RequestBody"
}
}, {
"name": "Proxy Permission (PS)",
"isExample": false,
"reference": {
"reference": "StructureDefinition/proxy-permission-ps"
}
}, {
"name": "proxy-permission-provider-actor-ps",
"isExample": false,
"reference": {
"reference": "ActorDefinition/proxy-permission-provider-actor-ps"
},
"description": "The Proxy Permission Provider can make available proxy permissions."
}, {
"name": "proxy-permission-provider-capabilities-ps",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/proxy-permission-provider-capabilities-ps"
},
"description": "Capabilities of a Proxy Permission Provider."
}, {
"name": "proxy-permission-reader-actor-ps",
"isExample": false,
"reference": {
"reference": "ActorDefinition/proxy-permission-reader-actor-ps"
},
"description": "The Proxy Permission Reader may retrieve proxy permissions."
}, {
"name": "proxy-permission-reader-capabilities-ps",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/proxy-permission-reader-capabilities-ps"
},
"description": "Capabilities of a Proxy Permission Reader."
}, {
"name": "RegisterGranteeConsent",
"isExample": false,
"reference": {
"reference": "OperationDefinition/RegisterGranteeConsent"
}
}, {
"name": "RegisterSignatureResponse",
"isExample": false,
"reference": {
"reference": "OperationDefinition/RegisterSignatureResponse"
}
}, {
"name": "RegisterSignatureResponse-Failed-ResponseBody",
"isExample": true,
"reference": {
"reference": "OperationOutcome/45868e4a-cd4d-4c0f-978f-422e8059973b"
}
}, {
"name": "RegisterSignatureResponse-PostXmlBinding-RequestBody",
"isExample": true,
"reference": {
"reference": "Parameters/RegisterSignatureResponse-PostXmlBinding-RequestBody"
}
}, {
"name": "RegisterSignatureResponse-Success-ResponseBody",
"isExample": true,
"reference": {
"reference": "OperationOutcome/766dc546-decc-4ee3-9484-c238b9e6c6e7"
}
}, {
"name": "Regulatorisk grund till spärr",
"isExample": false,
"reference": {
"reference": "ValueSet/re-regulatory-bases-of-restriction"
},
"description": "Includes regulatory bases of restrictions."
}, {
"name": "RelatedPersonRe",
"isExample": false,
"reference": {
"reference": "StructureDefinition/related-person-re"
},
"description": "Profile for expressing relationship to patient that can be used to restrict access to patient data."
}, {
"name": "Relationer person kan ha till en patient som grund till spärr",
"isExample": false,
"reference": {
"reference": "ValueSet/re-related-person-relationship"
},
"description": "Includes relationships which a related person can have to a patient against which access to data can be restricted."
}, {
"name": "RestrictDataFromCareGiver",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" ],
"isExample": true,
"reference": {
"reference": "Consent/885ab91c-bdcd-4104-8688-7f9ae7c37961"
}
}, {
"name": "RestrictEuCountries",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" ],
"isExample": true,
"reference": {
"reference": "Consent/7c4fb55e-2d4c-48cd-b32c-190e84cfee22"
}
}, {
"name": "RestrictIdentifiedLegalGuardian",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" ],
"isExample": true,
"reference": {
"reference": "Consent/5ad8e480-b58c-4a9c-9d45-256bed7cbc98"
}
}, {
"name": "Restriction (RE)",
"isExample": false,
"reference": {
"reference": "StructureDefinition/restriction-re"
},
"description": "Profile for restricting access to patient data"
}, {
"name": "restriction-manager-actor-re",
"isExample": false,
"reference": {
"reference": "ActorDefinition/restriction-manager-actor-re"
},
"description": "The Restriction Manager can process restrictions."
}, {
"name": "restriction-manager-capabilities-re",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/restriction-manager-capabilities-re"
},
"description": "Capabilities of a Restriction Manager."
}, {
"name": "restriction-resource-client-actor-re",
"isExample": false,
"reference": {
"reference": "ActorDefinition/restriction-resource-client-actor-re"
},
"description": "The Restriction Resource Client may read and create restrictions."
}, {
"name": "restriction-resource-client-capabilities-re",
"isExample": false,
"reference": {
"reference": "CapabilityStatement/restriction-resource-client-capabilities-re"
},
"description": "Capabilities of a Restriction Resource Client."
}, {
"name": "RestrictLegalGuardian",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/restriction-re" ],
"isExample": true,
"reference": {
"reference": "Consent/4f7a3c64-2f77-4b69-a649-35117acd64b4"
}
}, {
"name": "RevokeConsent",
"isExample": false,
"reference": {
"reference": "OperationDefinition/RevokeConsent"
},
"description": "Revokes a Consent resource."
}, {
"name": "RevokeConsent response body with message of POA revoked successfully",
"isExample": true,
"reference": {
"reference": "OperationOutcome/ee3dd06b-a6ac-4b3c-ad68-da920cce5271"
},
"description": "Example of response body with an OperationOutcome of successful RevokeConsent of power of attorney"
}, {
"name": "RevokeConsent response body with message of restriction already revoked",
"isExample": true,
"reference": {
"reference": "OperationOutcome/efa70f25-3ffb-4bc7-81b1-8e95d9ba0676"
},
"description": "Example of response body with an OperationOutcome of successful RevokeConsent operation of restriction but with information that restriction already is revoked."
}, {
"name": "RevokeConsent response body with message of restriction revoked successfully",
"isExample": true,
"reference": {
"reference": "OperationOutcome/20f45ca2-5759-436d-a0c3-cb4b71c4947e"
},
"description": "Example of response body with an OperationOutcome of successful RevokeConsent of restriction"
}, {
"name": "RevokeConsent response body with message of unauthorized to revoke POA",
"isExample": true,
"reference": {
"reference": "OperationOutcome/958f3ae0-d085-48d3-9e95-df5dc2537b42"
},
"description": "Example of response body with an OperationOutcome of failed RevokeConsent operation of authorization because revokedBy is unauthorized"
}, {
"name": "RevokeConsent response body with message of unauthorized to revoke restriction",
"isExample": true,
"reference": {
"reference": "OperationOutcome/abee7942-37c6-48d5-a149-71c723e4d4cb"
},
"description": "Example of response body with an OperationOutcome of failed RevokeConsent operation of restriction because revokedBy is unauthorized"
}, {
"name": "RevokeConsent response body with message of unknown logical ID of restriction",
"isExample": true,
"reference": {
"reference": "OperationOutcome/76063dec-4de7-45c2-a559-3432f147a317"
},
"description": "Example of response body with an OperationOutcome of failed RevokeConsent operation because of unknown logical ID of Consent"
}, {
"name": "RevokeConsent response body with POA already revoked message",
"isExample": true,
"reference": {
"reference": "OperationOutcome/77398b7d-6ff1-425b-ab7c-02fd981a28be"
},
"description": "Example of response body with an OperationOutcome of successful RevokeConsent of authorization operation but with information that Authorization already is revoked."
}, {
"name": "RevokeConsent-CoordinationNumber-RequestBody",
"isExample": true,
"reference": {
"reference": "Parameters/RevokeConsent-CoordinationNumber-RequestBody"
}
}, {
"name": "Roller som verifierar fullmakt",
"isExample": false,
"reference": {
"reference": "ValueSet/poa-verification-roles"
},
"description": "Includes roles that verifiers of a power of attorney can have."
}, {
"name": "Spärrkategorier",
"isExample": false,
"reference": {
"reference": "ValueSet/re-restriction-categories"
},
"description": "Includes categories of restrictions."
}, {
"name": "Status på fullmakt",
"isExample": false,
"reference": {
"reference": "ValueSet/poa-poa-statuses"
},
"description": "Includes statuses which a power of attorney can have."
}, {
"name": "Status på företrädarbehörighet",
"isExample": false,
"reference": {
"reference": "ValueSet/ps-proxy-permission-statuses"
},
"description": "Includes statuses which a proxy permission can have."
}, {
"name": "Status på spärr",
"isExample": false,
"reference": {
"reference": "ValueSet/re-restriction-statuses"
},
"description": "Includes statuses which a restriction can have."
}, {
"name": "UpdateConsentEffectivePeriod",
"isExample": false,
"reference": {
"reference": "OperationDefinition/UpdateConsentEffectivePeriod"
},
"description": "Updates effective period of a Consent resource."
}, {
"name": "UpdateConsentEffectivePeriod-CoordinationNumber-RequestBody",
"isExample": true,
"reference": {
"reference": "Parameters/UpdateConsentEffectivePeriod-CoordinationNumber-RequestBody"
}
}, {
"name": "UpdateConsentPeriod response body with message of invalid period",
"isExample": true,
"reference": {
"reference": "OperationOutcome/98c7d67f-fa5c-4162-8724-1fe20953a1e5"
},
"description": "Example of response body with an OperationOutcome of failed UpdateConsentPeriod operation because of invalid period"
}, {
"name": "UpdateConsentPeriod response body with message of passed new start date",
"isExample": true,
"reference": {
"reference": "OperationOutcome/1446c41c-ae48-4d41-8ae2-e53400629da1"
},
"description": "Example of response body with an OperationOutcome of failed UpdateConsentPeriod operation because new start date has passed"
}, {
"name": "UpdateConsentPeriod response body with message of passed old start date",
"isExample": true,
"reference": {
"reference": "OperationOutcome/1ac2f160-eaa7-44d6-a0c0-08803a6eb797"
},
"description": "Example of response body with an OperationOutcome of failed UpdateConsentPeriod operation because old start date has passed"
}, {
"name": "VerifiedAuthorization",
"profile": [ "http://electronichealth.se/fhir/NDI/StructureDefinition/power-of-attorney-poa" ],
"isExample": true,
"reference": {
"reference": "Consent/57d8e572-7dab-469a-ab33-ddeb7ad2a6b2"
}
} ],
"parameter": [ {
"code": {
"code": "copyrightyear",
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters"
},
"value": "2025+"
}, {
"code": {
"code": "releaselabel",
"system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters"
},
"value": "ci-build"
} ]
},
"date": null,
"publisher": "E-hälsomyndigheten (Swedish eHealth Agency)",
"fhirVersion": [ "5.0.0" ],
"jurisdiction": [ {
"coding": [ {
"code": "SE",
"system": "urn:iso:std:iso:3166",
"display": "Sweden"
} ]
} ],
"dependsOn": [ {
"id": "hl7_fhir_r5_core",
"uri": "http://hl7.org/fhir/ImplementationGuide/fhir",
"version": "5.0.0",
"packageId": "hl7.fhir.r5.core"
}, {
"id": "hl7_fhir_eu_base_r5",
"uri": "http://hl7.eu/fhir/base-r5/ImplementationGuide/hl7.fhir.eu.base-r5",
"version": "2.0.0",
"packageId": "hl7.fhir.eu.base-r5"
} ],
"name": "NationalRestrictionFunction",
"type": null,
"experimental": null,
"resourceType": "ImplementationGuide",
"title": "National Restriction Function",
"package_version": "0.1.3-alpha",
"status": "draft",
"id": "2a5536fa-3511-41a8-920b-9666fb5d1afc",
"kind": null,
"url": "http://electronichealth.se/fhir/NDI/ImplementationGuide/se.electronichealth.fhir.ppdr.r5",
"version": "0.1.0",
"packageId": "se.electronichealth.fhir.ppdr.r5",
"contact": [ {
"name": "E-hälsomyndigheten (Swedish eHealth Agency)",
"telecom": [ {
"value": "http://ehalsomyndigheten.se/",
"system": "url"
} ]
} ]
}