Release
4
5
Ballot
Terminology
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0-ballot:
R5
Ballot
-
Mixed
Normative
and
STU
see
ballot
notes
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
2.45.10
JSON
Schema
for
Parameters
|
|
Maturity Level : N/A | Standards Status : Informative |
|
This
is
a
representation
of
the
json
schema
for
Parameters,
which
is
just
a
part
of
the
full
Raw
JSON
Schema
.
(
canonical
form
+
also
see
JSON
Format
Specification
)
Definition for Value SetCoverage Class Codes
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/Parameters",
"$ref": "#/definitions/Parameters",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"Parameters": {
"description": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.",
"properties": {
"resourceType": {
"description": "This is a Parameters resource",
"const": "Parameters"
},
"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"
},
"parameter": {
"description": "A parameter passed to or received from the operation.",
"items": {
"$ref": "#/definitions/Parameters_Parameter"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"resourceType"
]
},
"Parameters_Parameter": {
"description": "This resource is a non-persisted resource used to pass information into and back from an [operation](operations.html). It has no other use, and there is no RESTful endpoint associated with it.",
"properties": {
"id": {
"description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"$ref": "string.schema.json#/definitions/string"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the element. 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 element and that modifies the understanding of the element in which it is contained 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 can 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"
},
"name": {
"description": "The name of the parameter (reference to the operation definition).",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBase64Binary": {
"description": "If the parameter is a data type.",
"pattern": "^(\\s*([0-9a-zA-Z\\+/\u003d]){4}\\s*)+$",
"type": "string"
},
"_valueBase64Binary": {
"description": "Extensions for valueBase64Binary",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueBoolean": {
"description": "If the parameter is a data type.",
"pattern": "^true|false$",
"type": "boolean"
},
"_valueBoolean": {
"description": "Extensions for valueBoolean",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCanonical": {
"description": "If the parameter is a data type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueCanonical": {
"description": "Extensions for valueCanonical",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueCode": {
"description": "If the parameter is a data type.",
"pattern": "^[^\\s]+(\\s[^\\s]+)*$",
"type": "string"
},
"_valueCode": {
"description": "Extensions for valueCode",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDate": {
"description": "If the parameter is a data type.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1]))?)?$",
"type": "string"
},
"_valueDate": {
"description": "Extensions for valueDate",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDateTime": {
"description": "If the parameter is a data type.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?$",
"type": "string"
},
"_valueDateTime": {
"description": "Extensions for valueDateTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueDecimal": {
"description": "If the parameter is a data type.",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?([eE][+-]?[0-9]+)?$",
"type": "number"
},
"_valueDecimal": {
"description": "Extensions for valueDecimal",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueId": {
"description": "If the parameter is a data type.",
"pattern": "^[A-Za-z0-9\\-\\.]{1,64}$",
"type": "string"
},
"_valueId": {
"description": "Extensions for valueId",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInstant": {
"description": "If the parameter is a data type.",
"pattern": "^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))$",
"type": "string"
},
"_valueInstant": {
"description": "Extensions for valueInstant",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueInteger": {
"description": "If the parameter is a data type.",
"pattern": "^-?([0]|([1-9][0-9]*))$",
"type": "number"
},
"_valueInteger": {
"description": "Extensions for valueInteger",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueMarkdown": {
"description": "If the parameter is a data type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueMarkdown": {
"description": "Extensions for valueMarkdown",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueOid": {
"description": "If the parameter is a data type.",
"pattern": "^urn:oid:[0-2](\\.(0|[1-9][0-9]*))+$",
"type": "string"
},
"_valueOid": {
"description": "Extensions for valueOid",
"$ref": "Element.schema.json#/definitions/Element"
},
"valuePositiveInt": {
"description": "If the parameter is a data type.",
"pattern": "^[1-9][0-9]*$",
"type": "number"
},
"_valuePositiveInt": {
"description": "Extensions for valuePositiveInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueString": {
"description": "If the parameter is a data type.",
"pattern": "^[ \\r\\n\\t\\S]+$",
"type": "string"
},
"_valueString": {
"description": "Extensions for valueString",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueTime": {
"description": "If the parameter is a data type.",
"pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?$",
"type": "string"
},
"_valueTime": {
"description": "Extensions for valueTime",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUnsignedInt": {
"description": "If the parameter is a data type.",
"pattern": "^[0]|([1-9][0-9]*)$",
"type": "number"
},
"_valueUnsignedInt": {
"description": "Extensions for valueUnsignedInt",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUri": {
"description": "If the parameter is a data type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUri": {
"description": "Extensions for valueUri",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUrl": {
"description": "If the parameter is a data type.",
"pattern": "^\\S*$",
"type": "string"
},
"_valueUrl": {
"description": "Extensions for valueUrl",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueUuid": {
"description": "If the parameter is a data type.",
"pattern": "^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"type": "string"
},
"_valueUuid": {
"description": "Extensions for valueUuid",
"$ref": "Element.schema.json#/definitions/Element"
},
"valueAddress": {
"description": "If the parameter is a data type.",
"$ref": "Address.schema.json#/definitions/Address"
},
"valueAge": {
"description": "If the parameter is a data type.",
"$ref": "Age.schema.json#/definitions/Age"
},
"valueAnnotation": {
"description": "If the parameter is a data type.",
"$ref": "Annotation.schema.json#/definitions/Annotation"
},
"valueAttachment": {
"description": "If the parameter is a data type.",
"$ref": "Attachment.schema.json#/definitions/Attachment"
},
"valueCodeableConcept": {
"description": "If the parameter is a data type.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"valueCoding": {
"description": "If the parameter is a data type.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"valueContactPoint": {
"description": "If the parameter is a data type.",
"$ref": "ContactPoint.schema.json#/definitions/ContactPoint"
},
"valueCount": {
"description": "If the parameter is a data type.",
"$ref": "Count.schema.json#/definitions/Count"
},
"valueDistance": {
"description": "If the parameter is a data type.",
"$ref": "Distance.schema.json#/definitions/Distance"
},
"valueDuration": {
"description": "If the parameter is a data type.",
"$ref": "Duration.schema.json#/definitions/Duration"
},
"valueHumanName": {
"description": "If the parameter is a data type.",
"$ref": "HumanName.schema.json#/definitions/HumanName"
},
"valueIdentifier": {
"description": "If the parameter is a data type.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"valueMoney": {
"description": "If the parameter is a data type.",
"$ref": "Money.schema.json#/definitions/Money"
},
"valuePeriod": {
"description": "If the parameter is a data type.",
"$ref": "Period.schema.json#/definitions/Period"
},
"valueQuantity": {
"description": "If the parameter is a data type.",
"$ref": "Quantity.schema.json#/definitions/Quantity"
},
"valueRange": {
"description": "If the parameter is a data type.",
"$ref": "Range.schema.json#/definitions/Range"
},
"valueRatio": {
"description": "If the parameter is a data type.",
"$ref": "Ratio.schema.json#/definitions/Ratio"
},
"valueReference": {
"description": "If the parameter is a data type.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"valueSampledData": {
"description": "If the parameter is a data type.",
"$ref": "SampledData.schema.json#/definitions/SampledData"
},
"valueSignature": {
"description": "If the parameter is a data type.",
"$ref": "Signature.schema.json#/definitions/Signature"
},
"valueTiming": {
"description": "If the parameter is a data type.",
"$ref": "Timing.schema.json#/definitions/Timing"
},
"valueContactDetail": {
"description": "If the parameter is a data type.",
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"valueContributor": {
"description": "If the parameter is a data type.",
"$ref": "Contributor.schema.json#/definitions/Contributor"
},
"valueDataRequirement": {
"description": "If the parameter is a data type.",
"$ref": "DataRequirement.schema.json#/definitions/DataRequirement"
},
"valueExpression": {
"description": "If the parameter is a data type.",
"$ref": "Expression.schema.json#/definitions/Expression"
},
"valueParameterDefinition": {
"description": "If the parameter is a data type.",
"$ref": "ParameterDefinition.schema.json#/definitions/ParameterDefinition"
},
"valueRelatedArtifact": {
"description": "If the parameter is a data type.",
"$ref": "RelatedArtifact.schema.json#/definitions/RelatedArtifact"
},
"valueTriggerDefinition": {
"description": "If the parameter is a data type.",
"$ref": "TriggerDefinition.schema.json#/definitions/TriggerDefinition"
},
"valueUsageContext": {
"description": "If the parameter is a data type.",
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"valueDosage": {
"description": "If the parameter is a data type.",
"$ref": "Dosage.schema.json#/definitions/Dosage"
},
"valueMeta": {
"description": "If the parameter is a data type.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"resource": {
"description": "If the parameter is a whole resource.",
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"part": {
"description": "A named part of a multi-part parameter.",
"items": {
"$ref": "#/definitions/Parameters_Parameter"
},
"type": "array"
}
},
"additionalProperties": false
}
"resourceType" : "ValueSet",
"id" : "coverage-class",
"meta" : {
"lastUpdated" : "2022-09-10T04:52:37.223+10:00",
"profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
},
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><ul><li>Include all codes defined in <a href=\"http://terminology.hl7.org/3.1.0/CodeSystem-coverage-class.html\"><code>http://terminology.hl7.org/CodeSystem/coverage-class</code></a></li></ul></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fm"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2
}],
"url" : "http://hl7.org/fhir/ValueSet/coverage-class",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.3.1009"
}],
"version" : "5.0.0-ballot",
"name" : "CoverageClassCodes",
"title" : "Coverage Class Codes",
"status" : "draft",
"experimental" : false,
"publisher" : "Financial Management",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "This value set includes Coverage Class codes.",
"copyright" : "HL7 Inc.",
"compose" : {
"include" : [{
"system" : "http://terminology.hl7.org/CodeSystem/coverage-class"
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
®©
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Sat,
Sep
10,
2022
04:57+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change