Artifact Index
Requirements: Actor Definitions
The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.
| Name | Description |
|---|---|
| Endpoint Consumer Actor | System that consumes information about the technical endpoints stored in the registry. |
| Endpoint Registry Actor | Registry for storing information about technical endpoints for retrieval of health information. |
| Medical Record Index Actor | Registry for storing indices of medical records of patients spread out in different systems at different care providers. |
| Medical Record Index Writer Actor | System responsible for registration and unregistration of medical record indices. |
| Medical Record Location Consumer Actor | System that consumes endpoints where medical records can be found. |
| Medical Record Locator Actor | System that locates endpoints where medical records can be found. |
| Organization Endpoint Writer Actor | System that provides information about technical endpoints to the endpoint registry. |
Behavior: Capability Statements
The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.
| Name | Description |
|---|---|
| Endpoint Consumer Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Endpoint Consumer Actor must support. |
| Endpoint Registry Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Endpoint Registry Actor must support. |
| Medical Record Index Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Medical Record Index Actor must support. |
| Medical Record Index Writer Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Medical Record Index Writer Actor must support. |
| Medical Record Location Consumer Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Medical Record Location Consumer Actor must support. |
| Medical Record Locator Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Medical Record Locator Actor must support. |
| Organization Endpoint Writer Capabilities | This Capability Statement describes the FHIR® REST capabilities that the Organization Endpoint Writer Actor must support. |
Behavior: Operation Definitions
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| Name | Description |
|---|---|
| AddOrganization | Adds Endpoint to Organization.endpoint. |
| Create Index Record | Creates an index record with a healthcare provider and patient. |
| RemoveOrganization | Removes Endpoint from Organization.endpoint. |
| Search Endpoint | Search for active Endpoints where healthcare providers, which a patient has been registered at, make patient data available. |
| Unregister Index Record | Unregisters an index record of a healthcare provider and patient. |
Structures: Resource Profiles
These define constraints on FHIR® resources for systems conforming to this implementation guide.
| Name | Description |
|---|---|
| API Specification (ActorDefinition) | This profile holds information about a set of capabilities defined in an API specification. |
| Endpoint | This profile holds information about a technical address to an API. |
| Organization | This profile holds information about organizations that can use endpoints. |
| Device | This profile holds information about technical properties of an API. |
Structures: Extensions
These are extensions used in this implementation guide. See General guidance for more information on extensions. Note that the links will open the extension in the project on Simplifier.
| Name | Description | URL |
|---|---|---|
| DeviceConformsToActorDefinitionEr | ActorDefinition that this device (API) is implementing. | http://electronichealth.se/fhir/NDI/StructureDefinition/device-conformsto-actor-definition-er |
| EndpointAssociatedServerEr | Associated server of this endpoint. | http://electronichealth.se/fhir/NDI/StructureDefinition/endpoint-associated-server-er |
Terminology: ValueSets
These are value sets used in this implementation guide. See General guidance for more information on value sets. Note that the links will open the value set in the project on Simplifier.
| Name | Canonical | Description | Version |
|---|---|---|---|
| Egenskaper som API:t har | http://electronichealth.se/fhir/NDI/ValueSet/er-device-property-types | Includes the property types of ER Device. | 0.1.0 |
| Error codes (ER) | http://electronichealth.se/fhir/NDI/ValueSet/er-error-codes | Includes error and success messages for Endpoint Registry transactions. | 0.1.0 |
| Error codes (MeRI) | http://electronichealth.se/fhir/NDI/ValueSet/meri-error-codes | Includes error and success messages for Medical Record Indexing transactions. | 0.1.0 |
| Kategorier av API-specifikationer | http://electronichealth.se/fhir/NDI/ValueSet/er-api-specification-categories | Includes categories of API specifications. | 0.1.0 |
| Protokoller som ändpunkter följer | http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-connection-type | Includes connection types of endpoints. | 0.1.0 |
| Säkerhetsmetod för API | http://electronichealth.se/fhir/NDI/ValueSet/er-device-security-method | Includes the security methods of ER Device. | 0.1.0 |
| Statusar på ändpunkt | http://electronichealth.se/fhir/NDI/ValueSet/er-endpoint-statuses | Includes statuses of endpoints. | 0.1.0 |
| Statusar på API (Device) | http://electronichealth.se/fhir/NDI/ValueSet/er-device-statuses | Includes statuses of devices. | 0.1.0 |
| Typ av organisation | http://electronichealth.se/fhir/NDI/ValueSet/er-organization-type | Includes types of organizations. | 0.1.0 |
| Typ av server | http://electronichealth.se/fhir/NDI/ValueSet/er-server-types | Includes types of servers. | 0.1.0 |