Conformance
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:
|
Standards Status : Informative |
|
Raw Turtle (+ also see Turtle/RDF Format Specification )
Operation Definition
@prefix fhir: <http://hl7.org/fhir/> . @prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . @prefix xsd: <http://www.w3.org/2001/XMLSchema#> . # - resource -------------------------------------------------------------------[] a fhir:OperationDefinition; fhir:Resource.id [ fhir:value "CodeSystem-validate-code"]; fhir:DomainResource.text [ fhir:Narrative.status [ fhir:value "generated" ] ]; fhir:DomainResource.extension [ fhir:index 0; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ]; fhir:Extension.value [ fhir:value "5" ] ], [ fhir:index 1; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ]; fhir:Extension.value [ fhir:value "normative" ] ], [ fhir:index 2; fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version" ]; fhir:Extension.value [ fhir:value "4.0.1" ] ]; fhir:OperationDefinition.url [ fhir:value "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code"]; fhir:OperationDefinition.version [ fhir:value "4.0.1"]; fhir:OperationDefinition.name [ fhir:value "Code System based Validation"]; fhir:OperationDefinition.status [ fhir:value "draft"]; fhir:OperationDefinition.kind [ fhir:value "operation"]; fhir:OperationDefinition.date [ fhir:value "2019-11-01T09:29:23+11:00"]; fhir:OperationDefinition.publisher [ fhir:value "HL7 (FHIR Project)"]; fhir:OperationDefinition.contact [ fhir:index 0; fhir:ContactDetail.telecom [ fhir:index 0; fhir:ContactPoint.system [ fhir:value "url" ]; fhir:ContactPoint.value [ fhir:value "http://hl7.org/fhir" ] ], [ fhir:index 1; fhir:ContactPoint.system [ fhir:value "email" ]; fhir:ContactPoint.value [ fhir:value "fhir@lists.hl7.org" ]<http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code> a fhir:OperationDefinition ; fhir:nodeRole fhir:treeRoot ; fhir:id [ fhir:v "CodeSystem-validate-code"] ; # fhir:text [ fhir:status [ fhir:v "generated" ] ; fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition CodeSystem-validate-code</b></p><a name=\"CodeSystem-validate-code\"> </a><a name=\"hcCodeSystem-validate-code\"> </a><p>URL: [base]/CodeSystem/$validate-code</p><p>URL: [base]/CodeSystem/[id]/$validate-code</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>url</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server</p>\n</div></td></tr><tr><td>IN</td><td>codeSystem</td><td>type</td><td>0..1</td><td><a href=\"codesystem.html\">CodeSystem</a></td><td/><td><div><p>The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server</p>\n</div></td></tr><tr><td>IN</td><td>code</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The code that is to be validated</p>\n</div></td></tr><tr><td>IN</td><td>version</td><td>type</td><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The version of the code system, if one was provided in the source data</p>\n</div></td></tr><tr><td>IN</td><td>display</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent</p>\n</div></td></tr><tr><td>IN</td><td>coding</td><td/><td>0..1</td><td><a href=\"datatypes.html#Coding\">Coding</a></td><td/><td><div><p>A coding to validate. The system must match the specified code system</p>\n</div></td></tr><tr><td>IN</td><td>codeableConcept</td><td/><td>0..1</td><td><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present</p>\n</div></td></tr><tr><td>IN</td><td>date</td><td/><td>0..1</td><td><a href=\"datatypes.html#dateTime\">dateTime</a></td><td/><td><div><p>The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.</p>\n</div></td></tr><tr><td>IN</td><td>abstract</td><td/><td>0..1</td><td><a href=\"datatypes.html#boolean\">boolean</a></td><td/><td><div><p>If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.</p>\n<p>Note that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context.</p>\n</div></td></tr><tr><td>IN</td><td>displayLanguage</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>Specifies the language to be used for description when validating the display property</p>\n</div></td></tr><tr><td>OUT</td><td>result</td><td/><td>1..1</td><td><a href=\"datatypes.html#boolean\">boolean</a></td><td/><td><div><p>True if the concept details supplied are valid</p>\n</div></td></tr><tr><td>OUT</td><td>message</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>Error details, if result = false. If this is provided when result = true, the message carries hints and warnings</p>\n</div></td></tr><tr><td>OUT</td><td>display</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>A valid display for the concept if the system wishes to display this to a user</p>\n</div></td></tr><tr><td>OUT</td><td>code</td><td/><td>0..1</td><td><a href=\"datatypes.html#code\">code</a></td><td/><td><div><p>The code that was validated</p>\n</div></td></tr><tr><td>OUT</td><td>system</td><td/><td>0..1</td><td><a href=\"datatypes.html#uri\">uri</a></td><td/><td><div><p>The system for the code that was validated</p>\n</div></td></tr><tr><td>OUT</td><td>version</td><td/><td>0..1</td><td><a href=\"datatypes.html#string\">string</a></td><td/><td><div><p>The version of the system of the code that was validated</p>\n</div></td></tr><tr><td>OUT</td><td>codeableConcept</td><td/><td>0..1</td><td><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></td><td/><td><div><p>A codeableConcept containing codings for all the validated codes</p>\n</div></td></tr><tr><td>OUT</td><td>issues</td><td/><td>0..1</td><td><a href=\"operationoutcome.html\">OperationOutcome</a></td><td/><td><div><p>List of itemised issues with paths constrained to simple FHIRPath. Examples are CodeableConcept, CodeableConcept.coding[0], CodeableConcept.coding[1].display, or Coding.display</p>\n</div></td></tr></table></div>"^^rdf:XMLLiteral ] ] ; # fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm> ] ; fhir:value [ a fhir:Integer ; fhir:v 5 ]]; fhir:OperationDefinition.description [ fhir:value "Validate that a coded value is in the code system. If the operation is not called at the instance level, one of the parameters \"url\" or \"codeSystem\" must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.\n\nWhen invoking this operation, a client SHALL provide one (and only one) of the parameters (code+system, coding, or codeableConcept). Other parameters (including version and display) are optional"]; fhir:OperationDefinition.code [ fhir:value "validate-code"]; fhir:OperationDefinition.resource [ fhir:value "CodeSystem"; fhir:index 0 ]; fhir:OperationDefinition.system [ fhir:value "false"]; fhir:OperationDefinition.type [ fhir:value "true"]; fhir:OperationDefinition.instance [ fhir:value "true"]; fhir:OperationDefinition.parameter [ fhir:index 0; fhir:OperationDefinition.name [ fhir:value "url" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server" ]; fhir:OperationDefinition.type [ fhir:value "uri" ] ], [ fhir:index 1; fhir:OperationDefinition.name [ fhir:value "codeSystem" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server" ]; fhir:OperationDefinition.type [ fhir:value "CodeSystem" ] ], [ fhir:index 2; fhir:OperationDefinition.name [ fhir:value "code" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "The code that is to be validated" ]; fhir:OperationDefinition.type [ fhir:value "code" ] ], [ fhir:index 3; fhir:OperationDefinition.name [ fhir:value "version" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "The version of the code system, if one was provided in the source data" ]; fhir:OperationDefinition.type [ fhir:value "string" ] ], [ fhir:index 4; fhir:OperationDefinition.name [ fhir:value "display" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent" ]; fhir:OperationDefinition.type [ fhir:value "string" ] ], [ fhir:index 5; fhir:OperationDefinition.name [ fhir:value "coding" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "A coding to validate. The system must match the specified code system" ]; fhir:OperationDefinition.type [ fhir:value "Coding" ] ], [ fhir:index 6; fhir:OperationDefinition.name [ fhir:value "codeableConcept" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present" ]; fhir:OperationDefinition.type [ fhir:value "CodeableConcept" ] ], [ fhir:index 7; fhir:OperationDefinition.name [ fhir:value "date" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy." ]; fhir:OperationDefinition.type [ fhir:value "dateTime" ] ], [ fhir:index 8; fhir:OperationDefinition.name [ fhir:value "abstract" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.\n\nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context." ]; fhir:OperationDefinition.type [ fhir:value "boolean" ] ], [ fhir:index 9; fhir:OperationDefinition.name [ fhir:value "displayLanguage" ]; fhir:OperationDefinition.use [ fhir:value "in" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "Specifies the language to be used for description when validating the display property" ]; fhir:OperationDefinition.type [ fhir:value "code" ] ], [ fhir:index 10; fhir:OperationDefinition.name [ fhir:value "result" ]; fhir:OperationDefinition.use [ fhir:value "out" ]; fhir:OperationDefinition.min [ fhir:value "1" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "True if the concept details supplied are valid" ]; fhir:OperationDefinition.type [ fhir:value "boolean" ] ], [ fhir:index 11; fhir:OperationDefinition.name [ fhir:value "message" ]; fhir:OperationDefinition.use [ fhir:value "out" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "Error details, if result = false. If this is provided when result = true, the message carries hints and warnings" ]; fhir:OperationDefinition.type [ fhir:value "string" ] ], [ fhir:index 12; fhir:OperationDefinition.name [ fhir:value "display" ]; fhir:OperationDefinition.use [ fhir:value "out" ]; fhir:OperationDefinition.min [ fhir:value "0" ]; fhir:OperationDefinition.max [ fhir:value "1" ]; fhir:OperationDefinition.documentation [ fhir:value "A valid display for the concept if the system wishes to display this to a user" ]; fhir:OperationDefinition.type [ fhir:value "string" ] ] .] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status> ] ; fhir:value [ a fhir:Code ; fhir:v "normative" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/StructureDefinition/structuredefinition-wg> ] ; fhir:value [ a fhir:Code ; fhir:v "vocab" ] ] ) ; # fhir:url [ fhir:v "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code"^^xsd:anyURI ; fhir:l <http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code> ] ; # fhir:version [ fhir:v "6.0.0-ballot3"] ; # fhir:name [ fhir:v "ValidateCode"] ; # fhir:title [ fhir:v "Code System based Validation"] ; # fhir:status [ fhir:v "active"] ; # fhir:kind [ fhir:v "operation"] ; # fhir:experimental [ fhir:v false] ; # fhir:date [ fhir:v "2025-11-10T15:17:08+00:00"^^xsd:dateTime] ; # fhir:publisher [ fhir:v "HL7 International / Terminology Infrastructure"] ; # fhir:contact ( [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://hl7.org/fhir" ] ] [ fhir:system [ fhir:v "email" ] ; fhir:value [ fhir:v "fhir@lists.hl7.org" ] ] ) ] [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/Vocab" ] ] ) ] ) ; # fhir:description [ fhir:v "Validate that a coded value is in the code system. If the operation is not called at the instance level, one of the parameters \"url\" or \"codeSystem\" must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code.\n\nWhen invoking this operation, a client **SHALL** provide one (and only one) of the parameters (code+system, coding, or codeableConcept). Other parameters (including version and display) are optional. When validating a code or a coding, then the code, system and version output parameters **SHOULD** be populated when possible. When a validating a CodeableConcept, then the codeableConcept output parameter **SHOULD** be populated when possible."] ; # fhir:jurisdiction ( [ fhir:coding ( [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm"^^xsd:anyURI ; fhir:l <http://unstats.un.org/unsd/methods/m49/m49.htm> ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] ) ; # fhir:affectsState [ fhir:v false] ; # fhir:code [ fhir:v "validate-code"] ; # fhir:resource ( [ fhir:v "CodeSystem"] ) ; # fhir:system [ fhir:v false] ; # fhir:type [ fhir:v true] ; # fhir:instance [ fhir:v true] ; # fhir:parameter ( [ fhir:name [ fhir:v "url" ] ; fhir:use [ fhir:v "in" ] ; fhir:scope ( [ fhir:v "type" ] ) ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server'scode systems, or it is known implicitly by the server" ] ; fhir:type [ fhir:v "uri" ] ] [ fhir:name [ fhir:v "codeSystem" ] ; fhir:use [ fhir:v "in" ] ; fhir:scope ( [ fhir:v "type" ] ) ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The codeSystem is provided directly as part of the request. Servers may choose not to accept code systems in this fashion. This parameter is used when the client wants the server to check against a code system that is not stored on the server" ] ; fhir:type [ fhir:v "CodeSystem" ] ] [ fhir:name [ fhir:v "code" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The code that is to be validated" ] ; fhir:type [ fhir:v "code" ] ] [ fhir:name [ fhir:v "version" ] ; fhir:use [ fhir:v "in" ] ; fhir:scope ( [ fhir:v "type" ] ) ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The version of the code system, if one was provided in the source data" ] ; fhir:type [ fhir:v "string" ] ] [ fhir:name [ fhir:v "display" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent" ] ; fhir:type [ fhir:v "string" ] ] [ fhir:name [ fhir:v "coding" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "A coding to validate. The system must match the specified code system" ] ; fhir:type [ fhir:v "Coding" ] ] [ fhir:name [ fhir:v "codeableConcept" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "A full codeableConcept to validate. The server returns true if one of the coding values is in the code system, and may also validate that the codings are not in conflict with each other if more than one is present" ] ; fhir:type [ fhir:v "CodeableConcept" ] ] [ fhir:name [ fhir:v "date" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy." ] ; fhir:type [ fhir:v "dateTime" ] ] [ fhir:name [ fhir:v "abstract" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid.\n\nNote that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context." ] ; fhir:type [ fhir:v "boolean" ] ] [ fhir:name [ fhir:v "displayLanguage" ] ; fhir:use [ fhir:v "in" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "Specifies the language to be used for description when validating the display property" ] ; fhir:type [ fhir:v "code" ] ] [ fhir:name [ fhir:v "result" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "1"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "True if the concept details supplied are valid" ] ; fhir:type [ fhir:v "boolean" ] ] [ fhir:name [ fhir:v "message" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "Error details, if result = false. If this is provided when result = true, the message carries hints and warnings" ] ; fhir:type [ fhir:v "string" ] ] [ fhir:name [ fhir:v "display" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "A valid display for the concept if the system wishes to display this to a user" ] ; fhir:type [ fhir:v "string" ] ] [ fhir:name [ fhir:v "code" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The code that was validated" ] ; fhir:type [ fhir:v "code" ] ] [ fhir:name [ fhir:v "system" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The system for the code that was validated" ] ; fhir:type [ fhir:v "uri" ] ] [ fhir:name [ fhir:v "version" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "The version of the system of the code that was validated" ] ; fhir:type [ fhir:v "string" ] ] [ fhir:name [ fhir:v "codeableConcept" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "A codeableConcept containing codings for all the validated codes" ] ; fhir:type [ fhir:v "CodeableConcept" ] ] [ fhir:name [ fhir:v "issues" ] ; fhir:use [ fhir:v "out" ] ; fhir:min [ fhir:v "0"^^xsd:nonNegativeInteger ] ; fhir:max [ fhir:v "1" ] ; fhir:documentation [ fhir:v "List of itemised issues with paths constrained to simple FHIRPath. Examples are CodeableConcept, CodeableConcept.coding[0], CodeableConcept.coding[1].display, or Coding.display" ] ; fhir:type [ fhir:v "OperationOutcome" ] ] ) . # # -------------------------------------------------------------------------------------
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)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Mon,
Nov
1,
2019
09:32+1100.
QA
Page
10,
2025
15:19+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change