This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Responsible
Owner:
Financial
Management
Work
Group
|
Standards Status : Informative |
Compartments
:
|
This is a representation of the json schema for EnrollmentResponse, which is just a part of the full JSON Schema .
{ "$schema": "http://json-schema.org/draft-06/schema#", "id": "http://hl7.org/fhir/json-schema/EnrollmentResponse", "$ref": "#/definitions/EnrollmentResponse", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "EnrollmentResponse": { "description": "This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.", "properties": { "resourceType": { "description": "This is a EnrollmentResponse resource", "const": "EnrollmentResponse" }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "$ref": "id.schema.json#/definitions/id" }, "meta": { "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "$ref": "Meta.schema.json#/definitions/Meta" }, "implicitRules": { "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "$ref": "#/definitions/uri" }, "_implicitRules": { "description": "Extensions for implicitRules", "$ref": "Element.schema.json#/definitions/Element" }, "language": { "description": "The base language in which the resource is written.", "$ref": "#/definitions/code" }, "_language": { "description": "Extensions for language", "$ref": "Element.schema.json#/definitions/Element" }, "text": { "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "$ref": "Narrative.schema.json#/definitions/Narrative" }, "contained": { "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "items": { "$ref": "ResourceList.schema.json#/definitions/ResourceList" }, "type": "array" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "identifier": { "description": "The Response business identifier.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "status": { "description": "The status of the resource instance.", "$ref": "#/definitions/code" }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "request": { "description": "Original request resource reference.", "$ref": "Reference.schema.json#/definitions/Reference" }, "outcome": { "description": "Processing status: error, complete.", "enum": [ "queued", "complete", "error", "partial" ] }, "_outcome": { "description": "Extensions for outcome", "$ref": "Element.schema.json#/definitions/Element" }, "disposition": { "description": "A description of the status of the adjudication.", "$ref": "#/definitions/string" }, "_disposition": { "description": "Extensions for disposition", "$ref": "Element.schema.json#/definitions/Element" }, "created": { "description": "The date when the enclosed suite of services were performed or completed.", "$ref": "#/definitions/dateTime" }, "_created": { "description": "Extensions for created", "$ref": "Element.schema.json#/definitions/Element" }, "organization": { "description": "The Insurer who produced this adjudicated response.", "$ref": "Reference.schema.json#/definitions/Reference" }, "requestProvider": { "description": "The practitioner who is responsible for the services rendered to the patient.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "additionalProperties": false, "required": [ "resourceType" ] } }{ "$schema": "http://json-schema.org/draft-06/schema#", "id": "http://hl7.org/fhir/json-schema/EnrollmentResponse", "$ref": "#/definitions/EnrollmentResponse", "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas", "definitions": { "EnrollmentResponse": { "description": "This resource provides enrollment and plan details from the processing of an EnrollmentRequest resource.", "properties": { "resourceType": { "description": "This is a EnrollmentResponse resource", "const": "EnrollmentResponse" }, "id": { "description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "$ref": "id.schema.json#/definitions/id" }, "meta": { "description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "$ref": "Meta.schema.json#/definitions/Meta" }, "implicitRules": { "description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.", "$ref": "#/definitions/uri" }, "_implicitRules": { "description": "Extensions for implicitRules", "$ref": "Element.schema.json#/definitions/Element" }, "language": { "description": "The base language in which the resource is written.", "$ref": "#/definitions/code" }, "_language": { "description": "Extensions for language", "$ref": "Element.schema.json#/definitions/Element" }, "text": { "description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "$ref": "Narrative.schema.json#/definitions/Narrative" }, "contained": { "description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.", "items": { "$ref": "ResourceList.schema.json#/definitions/ResourceList" }, "type": "array" }, "extension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "modifierExtension": { "description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "items": { "$ref": "Extension.schema.json#/definitions/Extension" }, "type": "array" }, "identifier": { "description": "The Response business identifier.", "items": { "$ref": "Identifier.schema.json#/definitions/Identifier" }, "type": "array" }, "status": { "description": "The status of the resource instance.", "$ref": "#/definitions/code" }, "_status": { "description": "Extensions for status", "$ref": "Element.schema.json#/definitions/Element" }, "request": { "description": "Original request resource reference.", "$ref": "Reference.schema.json#/definitions/Reference" }, "outcome": { "description": "Processing status: error, complete.", "$ref": "#/definitions/code" }, "_outcome": { "description": "Extensions for outcome", "$ref": "Element.schema.json#/definitions/Element" }, "disposition": { "description": "A description of the status of the adjudication.", "$ref": "#/definitions/string" }, "_disposition": { "description": "Extensions for disposition", "$ref": "Element.schema.json#/definitions/Element" }, "created": { "description": "The date when the enclosed suite of services were performed or completed.", "$ref": "#/definitions/dateTime" }, "_created": { "description": "Extensions for created", "$ref": "Element.schema.json#/definitions/Element" }, "organization": { "description": "The Insurer who produced this adjudicated response.", "$ref": "Reference.schema.json#/definitions/Reference" }, "requestProvider": { "description": "The practitioner who is responsible for the services rendered to the patient.", "$ref": "Reference.schema.json#/definitions/Reference" }, "candidate": { "description": "The subject or group of subjects to be enrolled.", "$ref": "Reference.schema.json#/definitions/Reference" } }, "type": "object", "additionalProperties": false, "required": [ "resourceType" ] } } }