| Package | hl7.fhir.us.medmorph |
| Type | CapabilityStatement |
| Id | medmorph-knowledge-artifact-repository |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/medmorph/https://build.fhir.org/ig/HL7/fhir-medmorph/CapabilityStatement-medmorph-knowledge-artifact-repository.html |
| URL | http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-knowledge-artifact-repository |
| Version | 1.0.0 |
| Status | draft |
| Date | 2020-12-06 |
| Name | KnowledgeArtifactRepository |
| Title | Knowledge Artifact Repository |
| Realm | us |
| Authority | hl7 |
| Description | This CapabilityStatement defines the expected capabilities of the Knowledge Artifact Repository actor when conforming to the MedMorph RA IG. This actor is responsible for allowing creation, modification, and hosting of the Knowledge Artifacts. |
| Kind | requirements |
No resources found
| OperationDefinition | |
| PlanDefinition-get-kar | Get Knowledge Artifact |
| StructureDefinition | |
| us-ph-plandefinition | US Public Health PlanDefinition |
Note: links and images are rebased to the (stated) source
(Requirements Definition Capability Statement)
Canonical URL: http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-knowledge-artifact-repository
Published by: HL7 International - Public Health Work Group
This CapabilityStatement defines the expected capabilities of the Knowledge Artifact Repository actor when conforming to the MedMorph RA IG. This actor is responsible for allowing creation, modification, and hosting of the Knowledge Artifacts.
| FHIR Version: | 4.0.1 |
|---|---|
| Supported formats: | json |
This CapabilityStatement defines the expected capabilities of the Knowledge Artifact Repository actor when conforming to the MedMorph RA IG. This actor is responsible for allowing creation, modification, and hosting of the Knowledge Artifacts.
Security:
Knowledge Artifact Repository hosting Knowledge Artifacts which do not contain any PII, PHI or other organizational sensitive information, the Knowledge Artifact Repository SHALL follow the security requirements identified in FHIR Security guidance. For Knowledge Artifact Repository transactions involving Knowledge Artifacts containing PII and/or PHI, the SMART on FHIR Backend Services authorization should be used.
| Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete |
|---|---|---|---|---|---|---|---|---|
| PlanDefinition (Profile) | SHALL | SHALL | SHOULD | SHALL | SHALL | |||
| ValueSets, Library, Endpoint, Bundle (Knowledge Artifact Supporting Resources) | SHALL | SHALL |
The following FHIR operations SHALL be supported by the Knowledge Artifact Repository.
The following FHIR operations SHALL be supported by the Trusted Third Party.
Profile: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition
| Parameter | Type | Definition & Chaining |
|---|---|---|
| identifier | token | Search using identifiers as allowed according to the FHIR specification. |
| name | string | Search using PlanDefinition name. |
| publisher | string | Search using publisher name. |
| title | string | Search using title. |
| name and version | string, string | Search using name and version. |
FHIR{
"resourceType": "CapabilityStatement",
"id": "medmorph-knowledge-artifact-repository",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/us/medmorph/CapabilityStatement/medmorph-knowledge-artifact-repository",
"version": "1.0.0",
"name": "KnowledgeArtifactRepository",
"title": "Knowledge Artifact Repository",
"status": "draft",
"date": "2020-12-06",
"publisher": "HL7 International - Public Health Work Group",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/Special/committees/pher"
}
]
}
],
"description": "This CapabilityStatement defines the expected capabilities of the Knowledge Artifact Repository actor when conforming to the MedMorph RA IG. This actor is responsible for allowing creation, modification, and hosting of the Knowledge Artifacts.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"json"
],
"rest": [
{
"mode": "server",
"documentation": "The focus of the Knowledge Artifact Repository is to allow creation, modification and hosting of Knowledge Artifacts using FHIR APIs. Typically Public Health Agencies/Research Organizations create the artifacts and EHRs/Healthcare Organizations retrieve the artifacts. ",
"security": {
"description": "Implementations must meet the general security requirements documented in the security section of the implementation guide."
},
"resource": [
{
"type": "PlanDefinition",
"supportedProfile": [
"http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-plandefinition"
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type",
"documentation": "Allows discovery of existing PlanDefinition instances."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read",
"documentation": "Allows retrieval of a specific PlanDefinition instance."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "vread",
"documentation": "Allows retrieval of a historical version of a PlanDefinition instance."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "Allows creation of a PlanDefinition resource instance."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "update",
"documentation": "Allows update of a PlanDefinition resource instance."
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "name",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-name",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-publisher",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
"type": "string"
}
]
}
],
"operation": [
{
"name": "get-kar",
"definition": "http://hl7.org/fhir/us/medmorph/OperationDefinition/PlanDefinition-get-kar"
}
]
}
]
}