Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG
1.0.0-ballot - STU1 United States of America flag

This page is part of the Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Search for and Retrieve Registry Submission Definitions

This section describes the SRRD of this guide. This transaction is used by the Registry Submission Definition Creator, Registry Submission Definition Repository and Registry Submitter actors.

Scope

Search for and Retrieve Registry Submission Definitions

Actors Roles

Registry Submission Definition CreatorRegistry Submission Definition RepositoryRegistry SubmitterSearch / Retrieve Registry Definition
Figure 2.1-1: Search / Retrieve Registry Definition Use Case Diagram
Table 2.1-1: Actor Roles
ActorRole
Registry Submission Definition Creator Searches for or reads existing registry submission definition resources
Registry Submission Definition Repository Responds to requests to search or read for registry submission definition resources
Registry Submitter Searches for or reads existing registry submission definition resources

Referenced Standards

Table 3.71.3-1: Referenced Standards
StandardName
FHIR-R4HL7 FHIR Release 4.0
RFC-7230Hypertext Transfer Protocol - HTTP/1.1

Interactions

Registry SubmitterRegistry Submission Definition RepositoryRegistry Submission Definition Creator1. Search Request2. Search Request
Figure 2.1-2: Search / Retrieve Registry Definition Interactions

Search Request

Trigger Event -
Message Semantics

The client sends a query using an HTTP GET or POST transaction to the server requesting information on available resources.

The following are general requirements of the interaction.

read

A client shall be able to read individual resources that are returned or referenced within resources returned by a query.

The Registry Submission Definition Repository shall support the FHIR read operation on the StructureDefinition and StructureMap resources.

A client system shall be able to retrieve the definition data by publisher, condition, description or other text.

The Registry Submission Definition Repository shall support the FHIR search operation on the StructureDefinition and StructureMap resources with the following parameters.

Expected Actions

Conformance

See the following CapabilityStatement resources for conformance requirements:

  • CapabilityStatement-RSDR-SRRD Defines the requirements for the Registry Submission Definition Repository implementing the Search / Retrieve Registry Definition transaction.
  • CapabilityStatement-RS-SRRD Defines the requirements for the Registry Submitter implementing the Search / Retrieve Registry Definition transaction.