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. |
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. |
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. |
Example: Example instances
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.
| Name | Resource type | Description |
|---|---|---|
| FHIR based specification | ActorDefinition | |
| Rivta based specification | ActorDefinition | |
| FHIR based endpoint | Endpoint | |
| Rivta based endpoint | Endpoint | |
| Create Index Record Request Body 1 | Parameters | Example of request body for CreateIndexRecord operation with personal identity number as patient identifier |
| Create Index Record Request Body 2 | Parameters | Example of request body for CreateIndexRecord operation with coordination number as patient identifier |
| Invalid Values Create Index Record Request Body | Parameters | Example of invalid request body for CreateIndexRecord operation because of wrongly formatted personal identity number of sole trader Organization - valueIdentifier.value of first parameter has 10 digit version of personal identity number instead of 12 - and invalid value of identifier system of second parameter |
| Unregister Index Record Request Body 1 | Parameters | Example of request body for UnregisterIndexRecord operation with personal identity number as patient identifier |
| Unregister Index Record Request Body 2 | Parameters | Example of request body for UnregisterIndexRecord operation with coordination number as patient identifier |
| Invalid Unregister Index Record Request Body Format | Parameters | Example of invalid request body for UnregisterIndexRecord operation because of wrongly formatted organization identifier of healthcare provider - valueIdentifier.value has 9 digits instead of 10 - and invalid value of identifier system of patient parameter |
| Add Organization To Endpoint Request Body 1 | Parameters | |
| Search Endpoint Request Body 1 | Parameters | |
| Successful Create Index Record Response Body | OperationOutcome | Example of response body with an OperationOutcome of successful CreateIndexRecord operation |
| Index Record Already Exists Response Body | OperationOutcome | Example of response body with an OperationOutcome of successful CreateIndexRecord operation because index record already exists |
| Unsuccessful Create Index Record Response Body | OperationOutcome | Example of response body with an OperationOutcome of failed CreateIndexRecord operation because of invalid format of identifier parameter |
| Successful Unregister Index Record Response Body | OperationOutcome | Example of response body with an OperationOutcome of successful UnregisterIndexRecord operation |
| Index Record Not Found Response Body | OperationOutcome | Example of response body with an OperationOutcome of successful UnregisterIndexRecord operation because index record does not exist |
| Unsuccessful Unregister Index Record Response Body | OperationOutcome | Example of response body with an OperationOutcome of failed UnregisterIndexRecord operation because of invalid format of identifier |
| Successful Add Organization To Endpoint Response Body | OperationOutcome | |
| Organization Already Added To Endpoint Response Body | OperationOutcome | |
| Organization Already Removed From Endpoint Response Body | OperationOutcome | |
| Failed Add/Remove Organization Response Body | OperationOutcome | |
| Unsuccessful Search Endpoint Response Body 1 | OperationOutcome | |
| Unsuccessful Search Endpoint Response Body 2 | OperationOutcome | |
| Organization with organization identifier | Organization | |
| Organization with personal identity number | Organization |