3.3. Capability Statements
The Capability Statements are informative in nature and do not represent the minimum or maximum set of capabilities the client or server should support. The aim is to design the Capability Statements as complete as possible, however for the exact set of capabilities the complete IG should be consulted.
3.3.1. Pathology Reports (Retrieve)
REST Capabilities Client
| Mode | Client |
|---|---|
| Documentation | Minimal requirements for a client to fulfill the 'Retrieve pathology reports' transaction (system role: PA-PRR-1.0.0-alpha.3). |
| Search-system | Supported |
Resource Interactions
| Resource Type | Supported Profiles | SearchType | Read |
|---|---|---|---|
| DiagnosticReport | PathReport | ✓ | |
| ServiceRequest | PathRequest | ✓ | |
| Observation | PathReportClinicalInformation PathReportMacroscopy PathReportMicroscopy PathReportProtocolDataItem | ✓ | |
| Specimen | PathRequestSpecimen | ✓ | |
| Patient | PathPatient NlcorePatient | ✓ | |
| PractitionerRole | PathRequestRequester NlcoreHealthProfessionalPractitionerRole | ✓ | |
| Practitioner | NlcoreHealthProfessionalPractitioner | ✓ | |
| Organization | NlcoreHealthcareProviderOrganization | ✓ | |
| Location | NlcoreHealthcareProvider | ✓ |
Search Parameters per resource type
DiagnosticReport
| Name | Type | Documentation | Level |
|---|---|---|---|
| category | token | Supported | |
| status | token | Only complete and verified reports are to be exchanged, hence only searching on the value final needs to be supported. | Supported |
Supported Includes:
- DiagnosticReport:based-on
- DiagnosticReport:result
- DiagnosticReport:results-interpreter
- DiagnosticReport:specimen
ServiceRequest
No search parameters are stated for this resource type
Observation
No search parameters are stated for this resource type
Specimen
No search parameters are stated for this resource type
Patient
No search parameters are stated for this resource type
PractitionerRole
No search parameters are stated for this resource type
Practitioner
No search parameters are stated for this resource type
Organization
No search parameters are stated for this resource type
Location
No search parameters are stated for this resource type
--- We have skipped the narrative for better readability of the resource ---
</text>
</telecom>
</contact>
<description value="This CapabilityStatement describes the minimal requirements for a client to fulfill the 'Retrieve pathology reports' transaction within Pathology." />
<purpose value="This CapabilityStatement is informative in nature and does not represent the minimum or maximum set of capabilities the client or server should support. The aim is to design the CapabilityStatement as complete as possible, however for the exact set of capabilities the implementation guide should be consulted." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<documentation value="Minimal requirements for a client to fulfill the 'Retrieve pathology reports' transaction (system role: PA-PRR-1.0.0-alpha.3)." />
<documentation value="If the client always retrieves the ServiceRequest, Observation, Practitioner(Role) and Specimen resources referenced from the DiagnosticReport via individual `read` interactions, support of the `_include` values specified on `.searchInclude` is optional." />
</interaction>
</searchParam>
<documentation value="Only complete and verified reports are to be exchanged, hence only searching on the value _final_ needs to be supported." />
</searchParam>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the client always retrieves the ServiceRequest resource via the `_include` on `DiagnosticReport:based-on`, support of the `read` interaction is optional." />
</interaction>
</resource>
<supportedProfile value="http://medmij.nl/fhir/StructureDefinition/path-Report.ClinicalInformation" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the client always retrieves the Observation resources via the `_include` on `DiagnosticReport:result`, support of the `read` interaction is optional." />
</interaction>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the client always retrieves the Specimen resources via the `_include` on `DiagnosticReport:specimen`, support of the `read` interaction is optional." />
</interaction>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client." />
</interaction>
</resource>
<supportedProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client." />
</interaction>
</resource>
<supportedProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client." />
</interaction>
</resource>
<supportedProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client." />
</interaction>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client." />
</interaction>
</resource>
</interaction>
</rest>
</CapabilityStatement>
{
--- We have skipped the narrative for better readability of the resource ---
},
{
}
],
"description": "This CapabilityStatement describes the minimal requirements for a client to fulfill the 'Retrieve pathology reports' transaction within Pathology.",
"purpose": "This CapabilityStatement is informative in nature and does not represent the minimum or maximum set of capabilities the client or server should support. The aim is to design the CapabilityStatement as complete as possible, however for the exact set of capabilities the implementation guide should be consulted.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"xml",
"json"
],
{
"documentation": "Minimal requirements for a client to fulfill the 'Retrieve pathology reports' transaction (system role: PA-PRR-1.0.0-alpha.3).",
{
"http://medmij.nl/fhir/StructureDefinition/path-Report"
],
"documentation": "If the client always retrieves the ServiceRequest, Observation, Practitioner(Role) and Specimen resources referenced from the DiagnosticReport via individual `read` interactions, support of the `_include` values specified on `.searchInclude` is optional.",
],
"DiagnosticReport:based-on",
"DiagnosticReport:result",
"DiagnosticReport:results-interpreter",
"DiagnosticReport:specimen"
],
{
},
{
"documentation": "Only complete and verified reports are to be exchanged, hence only searching on the value _final_ needs to be supported."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Request"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the client always retrieves the ServiceRequest resource via the `_include` on `DiagnosticReport:based-on`, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Report.ClinicalInformation",
"http://medmij.nl/fhir/StructureDefinition/path-Report.Macroscopy",
"http://medmij.nl/fhir/StructureDefinition/path-Report.Microscopy",
"http://medmij.nl/fhir/StructureDefinition/path-Report.ProtocolDataItem"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the client always retrieves the Observation resources via the `_include` on `DiagnosticReport:result`, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Request.Specimen"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the client always retrieves the Specimen resources via the `_include` on `DiagnosticReport:specimen`, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Patient",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Request.Requester",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client."
}
]
},
{
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client."
}
]
},
{
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client."
}
]
},
{
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server includes this (secondary) resource in the Bundle, the client does not need to execute a `read`. However, since a server may choose to not include it in the Bundle, support of the `read` interaction is mandatory for a client."
}
]
}
],
]
}
]
}
3.3.2. Pathology Reports (Serve)
REST Capabilities Server
| Mode | Server |
|---|---|
| Documentation | Minimal requirements for a server to fulfill the 'Serve pathology reports' transaction (system role: PA-PRB-1.0.0-alpha.3). |
| Search-system | Supported |
Resource Interactions
| Resource Type | Supported Profiles | SearchType | Read |
|---|---|---|---|
| DiagnosticReport | PathReport | ✓ | |
| ServiceRequest | PathRequest | ✓ | |
| Observation | PathReportClinicalInformation PathReportMacroscopy PathReportMicroscopy PathReportProtocolDataItem | ✓ | |
| Specimen | PathRequestSpecimen | ✓ | |
| Patient | PathPatient NlcorePatient | ✓ | |
| PractitionerRole | PathRequestRequester NlcoreHealthProfessionalPractitionerRole | ✓ | |
| Practitioner | NlcoreHealthProfessionalPractitioner | ✓ | |
| Organization | NlcoreHealthcareProviderOrganization | ✓ | |
| Location | NlcoreHealthcareProvider | ✓ |
Search Parameters per resource type
DiagnosticReport
| Name | Type | Documentation | Level |
|---|---|---|---|
| category | token | Supported | |
| status | token | Only complete and verified reports are to be exchanged, hence only searching on the value final needs to be supported. | Supported |
Supported Includes:
- DiagnosticReport:based-on
- DiagnosticReport:result
- DiagnosticReport:results-interpreter
- DiagnosticReport:specimen
ServiceRequest
No search parameters are stated for this resource type
Observation
No search parameters are stated for this resource type
Specimen
No search parameters are stated for this resource type
Patient
No search parameters are stated for this resource type
PractitionerRole
No search parameters are stated for this resource type
Practitioner
No search parameters are stated for this resource type
Organization
No search parameters are stated for this resource type
Location
No search parameters are stated for this resource type
--- We have skipped the narrative for better readability of the resource ---
</text>
</telecom>
</contact>
<description value="This CapabilityStatement describes the minimal requirements for a server to fulfill the 'Serve pathology reports' transaction within Pathology." />
<purpose value="This CapabilityStatement is informative in nature and does not represent the minimum or maximum set of capabilities the client or server should support. The aim is to design the CapabilityStatement as complete as possible, however for the exact set of capabilities the implementation guide should be consulted." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<documentation value="Minimal requirements for a server to fulfill the 'Serve pathology reports' transaction (system role: PA-PRB-1.0.0-alpha.3)." />
</interaction>
</searchParam>
<documentation value="Only complete and verified reports are to be exchanged, hence only searching on the value _final_ needs to be supported." />
</searchParam>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<supportedProfile value="http://medmij.nl/fhir/StructureDefinition/path-Report.ClinicalInformation" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<supportedProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<supportedProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<supportedProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization" />
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
<documentation value="This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle." />
<documentation value="If the server always includes this resource in the Bundle, support of the `read` interaction is optional." />
</interaction>
</resource>
</interaction>
</rest>
</CapabilityStatement>
{
--- We have skipped the narrative for better readability of the resource ---
},
{
}
],
"description": "This CapabilityStatement describes the minimal requirements for a server to fulfill the 'Serve pathology reports' transaction within Pathology.",
"purpose": "This CapabilityStatement is informative in nature and does not represent the minimum or maximum set of capabilities the client or server should support. The aim is to design the CapabilityStatement as complete as possible, however for the exact set of capabilities the implementation guide should be consulted.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
"xml",
"json"
],
{
"documentation": "Minimal requirements for a server to fulfill the 'Serve pathology reports' transaction (system role: PA-PRB-1.0.0-alpha.3).",
{
"http://medmij.nl/fhir/StructureDefinition/path-Report"
],
],
"DiagnosticReport:based-on",
"DiagnosticReport:result",
"DiagnosticReport:results-interpreter",
"DiagnosticReport:specimen"
],
{
},
{
"documentation": "Only complete and verified reports are to be exchanged, hence only searching on the value _final_ needs to be supported."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Request"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Report.ClinicalInformation",
"http://medmij.nl/fhir/StructureDefinition/path-Report.Macroscopy",
"http://medmij.nl/fhir/StructureDefinition/path-Report.Microscopy",
"http://medmij.nl/fhir/StructureDefinition/path-Report.ProtocolDataItem"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Request.Specimen"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Patient",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-Patient"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://medmij.nl/fhir/StructureDefinition/path-Request.Requester",
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider-Organization"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
},
{
"http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthcareProvider"
],
"documentation": "This is a secondary resource that needs to be resolvable, either by supporting a `read` interaction or explicitly including it in the Bundle.",
{
"documentation": "If the server always includes this resource in the Bundle, support of the `read` interaction is optional."
}
]
}
],
]
}
]
}