| Package | hl7.fhir.us.sirb |
| Resource Type | CapabilityStatement |
| Id | sIRB-CapabilityStatementClient |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/sirb/https://build.fhir.org/ig/HL7/fhir-sirb/CapabilityStatement-sIRB-CapabilityStatementClient.html |
| URL | http://hl7.org/fhir/us/sirb/CapabilityStatement/sIRB-CapabilityStatementClient |
| Version | 1.0.0 |
| Status | draft |
| Date | 2022-10 |
| Name | CapabilityStatementClient_sIRB |
| Title | sIRB Client Capability Statement |
| Realm | us |
| Authority | hl7 |
| Description | This resource describes the required and desired behavior of software clients for use and exchange of the single Institutional Review Board (sIRB) forms. |
| Kind | requirements |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
(Requirements Definition Capability Statement)
Canonical URL: http://hl7.org/fhir/us/sirb/CapabilityStatement/sIRB-CapabilityStatementClient Version: 0.1.0 Published: 2022-10 (draft)
Published by: HL7 International - BR&R Work Group
This resource describes the required and desired behavior of software clients for use and exchange of the single Institutional Review Board (sIRB) forms.
| FHIR Version: | 4.0.1 |
|---|---|
| Supported formats: | xml, json |
Requirements for the REST FHIR Questionnaire Management Software (could be the research study system of the lead principal investigator's institution, another type of software or the sIRB on FHIR software).
Security:
Review the security recommendations on the FHIR Security page at http://hl7.org/fhir/R4/security.html
| Resource | Search | Read | Read Version | Instance History | Resource History | Create | Update | Delete | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Questionnaire | SHOULD | SHALL | MAY | ||||||
| QuestionnaireResponse | SHOULD | SHALL | SHALL | MAY | SHALL | SHALL | |||
| ResearchStudy | MAY | MAY | MAY | MAY | MAY | MAY | |||
| Provenance | MAY | MAY | MAY | MAY | MAY | MAY |
| Name | Conformance | Description |
|---|
| Parameter | Conformance | Type | Definition & Chaining |
|---|---|---|---|
| url | SHALL | uri | |
| version | SHOULD | token | |
| status | SHOULD | token | |
| _lastUpdated | SHOULD | date | |
| _id | MAY | token |
Versioning support: versioned-update
| Name | Conformance | Description |
|---|
Supported Includes: QuestionnaireResponse.questionnaire
| Parameter | Conformance | Type | Definition & Chaining |
|---|---|---|---|
| questionnaire | SHALL | reference | |
| author | SHALL | reference | |
| _lastUpdated | SHALL | date | |
| _id | MAY | token | |
| identifier | SHOULD | token | |
| status | SHALL | token |
Versioning support: versioned-update
| Name | Conformance | Description |
|---|
| Parameter | Conformance | Type | Definition & Chaining |
|---|---|---|---|
| identifier | MAY | token | |
| _id | MAY | token | |
| title | MAY | string | |
| keyword | MAY | token |
Versioning support: versioned-update
| Name | Conformance | Description |
|---|
| Parameter | Conformance | Type | Definition & Chaining |
|---|---|---|---|
| _id | MAY | token | |
| target | SHOULD | reference | |
| when | SHOULD | date |
FHIR{
"resourceType": "CapabilityStatement",
"id": "sIRB-CapabilityStatementClient",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.org/fhir/us/sirb/CapabilityStatement/sIRB-CapabilityStatementClient",
"version": "1.0.0",
"name": "CapabilityStatementClient_sIRB",
"title": "sIRB Client Capability Statement",
"status": "draft",
"date": "2022-10",
"publisher": "HL7 International - BR&R Work Group",
"contact": [
{
"name": "HL7 International - Biomedical Research and Regulation",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/rcrim"
}
]
}
],
"description": "This resource describes the required and desired behavior of software clients for use and exchange of the single Institutional Review Board (sIRB) forms.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US",
"display": "United States of America"
}
],
"text": "United States of America"
}
],
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"xml",
"json"
],
"patchFormat": [
"application/json-patch+json"
],
"rest": [
{
"mode": "client",
"documentation": "Requirements for the REST FHIR Questionnaire Management Software (could be the research study system of the lead principal investigator's institution, another type of software or the sIRB on FHIR software).",
"security": {
"description": "Review the security recommendations on the FHIR Security page at http://hl7.org/fhir/R4/security.html"
},
"resource": [
{
"type": "Questionnaire",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "url",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-url",
"type": "uri"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
}
]
},
{
"type": "QuestionnaireResponse",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
}
],
"versioning": "versioned-update",
"readHistory": true,
"searchInclude": [
"QuestionnaireResponse.questionnaire"
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "questionnaire",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-author",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-identifier",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status",
"type": "token"
}
]
},
{
"type": "ResearchStudy",
"documentation": "If an implementer wishes to optionally use the ResearchStudy resource to transmit or persist data, the R4 base definition of the ResearchStudy resource MAY be used.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "patch"
}
],
"versioning": "versioned-update",
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-identifier",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-title",
"type": "string"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "keyword",
"definition": "http://hl7.org/fhir/SearchParameter/ResearchStudy-keyword",
"type": "token"
}
]
},
{
"type": "Provenance",
"documentation": "If an implementer wishes to capture information about data creation, update, modification or deletion activities, the Provenance resource MAY be utilized. The Provenance resource can assist with data authenticity and assessing the entities involved with data being stored or transmitted via the system.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "vread"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "create"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "update"
}
],
"versioning": "versioned-update",
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "target",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-target",
"type": "reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "when",
"definition": "http://hl7.org/fhir/SearchParameter/Provenance-when",
"type": "date"
}
]
}
]
}
]
}