FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/sIRB-CapabilityStatementClient

Packagehl7.fhir.us.sirb
TypeCapabilityStatement
IdsIRB-CapabilityStatementClient
FHIR VersionR4
Sourcehttp://hl7.org/fhir/us/sirb/https://build.fhir.org/ig/HL7/fhir-sirb/CapabilityStatement-sIRB-CapabilityStatementClient.html
URLhttp://hl7.org/fhir/us/sirb/CapabilityStatement/sIRB-CapabilityStatementClient
Version1.0.0
Statusdraft
Date2022-10
NameCapabilityStatementClient_sIRB
TitlesIRB Client Capability Statement
Realmus
Authorityhl7
DescriptionThis resource describes the required and desired behavior of software clients for use and exchange of the single Institutional Review Board (sIRB) forms.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

sIRB Client Capability Statement

(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.

General

FHIR Version: 4.0.1
Supported formats: xml, json

REST client behavior

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 summary

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


Questionnaire

Interactions

Name Conformance Description

Search

Parameter Conformance Type Definition & Chaining
url SHALL uri
version SHOULD token
status SHOULD token
_lastUpdated SHOULD date
_id MAY token


QuestionnaireResponse

Behavior

Versioning support: versioned-update

Interactions

Name Conformance Description

Search

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


ResearchStudy

Behavior

Versioning support: versioned-update

Interactions

Name Conformance Description

Search

Parameter Conformance Type Definition & Chaining
identifier MAY token
_id MAY token
title MAY string
keyword MAY token


Provenance

Behavior

Versioning support: versioned-update

Interactions

Name Conformance Description

Search

Parameter Conformance Type Definition & Chaining
_id MAY token
target SHOULD reference
when SHOULD date

Source

{
  "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"
            }
          ]
        }
      ]
    }
  ]
}