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 |
|---|---|
| Medical Record Index Actor (MeRI) | The Medical Record Index system actor can store indices of medical records. |
| Medical Record Index Writer Actor (MeRI) | The Medical Record Index Writer system actor can request to create and unregister indices of medical records. |
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 |
|---|---|
| Medical Record Index Capabilities (MeRI) | This Capability Statement describes the FHIR REST capabilities that the Medical Record Index Actor must support. |
| Medical Record Index Writer Capabilities (MeRI) | This Capability Statement describes the FHIR REST capabilities that the Medical Record Index 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 |
|---|---|
| Create Index Record (MeRI) | Creates an index record with a healthcare provider and patient. |
| Unregister Index Record (MeRI) | 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 |
|---|---|---|
| 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 |
| 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 |
| 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 |
| 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 parameter |