Protocols for Clinical Registry Extraction and Data Submission (CREDS) IG, published by HL7 International / Clinical Interoperability Council. This is not an authorized publication; it is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/HL7/fhir-registry-protocols-ig/ and changes regularly. See the Directory of published versions

Create/Update Registry Definitions

Scope

Create / Update Registry Definition (CURD) This section describes the CURD of this guide. This transaction is used by the Registry Submission Definition Creator and Registry Submission Definition Repository actors.

Actors Roles

Table 2.2-1: Actor Roles

Actor	Role
Registry Submission Definition Creator	Creates or updates registry submission definition resources
Registry Submission Definition Repository	Stores registry submission definition resources

Referenced Standards

Table 3.71.3-1: Referenced Standards

Standard	Name
FHIR-R4	HL7 FHIR Release 4
RFC-7230	Hypertext Transfer Protocol - HTTP/1.1

Interactions

Create or Update Registry Submission Definition

Trigger Event - Create or Update Registry Submission Definition

A Registry Submission Definition Creator requests creation of a new Submission Definition. A logical model or submission transformation created by the Registry Submission Definition Creator is communicated to the Registry Submission Definition Source.

Message Semantics

The Registry Submission Definition Creator creates or updates StructureDefinition on the Registry Submission Definition Repository.

The following are general requirements of the interaction.

Formats

Parameter	Cardinality	Registry Submission Definition Repository Expectation	Registry Submitter Expectation
_format=application/fhir+xml|application/fhir+json	0..1	shall	shall
_format=xml|json|text/xml|application/json|application/xml|application/xml+fhir|application/json+fhir	0..1	should	should not
Accept:=application/fhir+xml|application/fhir+json	0..1	shall	shall
Accept:=xml|json|text/xml|application/json|application/xml|application/xml+fhir|application/json+fhir	0..1	should	should not

create

The Registry Submission Definition Repository shall support the FHIR create operation on the StructureDefinition resource.

update

The Registry Submission Definition Repository shall support the FHIR update operation on the StructureDefinition resource.

Expected Actions

Create StructureDefinition Resource

The Registry Submission Definition Creator creates or updates StructureDefinition resources and sends them to a Registry Submission Definition Repository

The Registry Submission Definition Creator performs the FHIR create operation on the StructureDefinition resource at a Registry Submission Definition Repository.

Accept Resource

The Registry Submission Consumer reports success using 200 OK, 201 Created, or 202 Accepted to indicate a successful create or update.

Conformance

See the following CapabilityStatement resources for conformance requirements:

• CapabilityStatement-RSDC-CURD Defines the requirements for the Registry Submission Definition Creator implementing the Create / Update Registry Definition transaction.
• CapabilityStatement-RSDR-CURD Defines the requirements for the Registry Submission Definition Repository implementing the Create / Update Registry Definition transaction.