Release 4B Snapshot #1
TerminologyThis page is part of the FHIR Specification v4.3.0-snapshot1: R4B Snapshot to support the Jan 2022 Connectathon. About the R4B version of FHIR. The current officially released version is 4.3.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4
| Vocabulary Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
This is a representation of the json schema for NamingSystem, 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/NamingSystem",
"$ref": "#/definitions/NamingSystem",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"NamingSystem": {
"description": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"properties": {
"resourceType": {
"description": "This is a NamingSystem resource",
"const": "NamingSystem"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "string.schema.json#/definitions/string"
},
"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"
},
"name": {
"description": "A natural language name identifying the naming system. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"$ref": "#/definitions/string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this naming system. Enables tracking the life-cycle of the content.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"kind": {
"description": "Indicates the purpose for the naming system - what kinds of things does it make unique?",
"$ref": "#/definitions/code"
},
"_kind": {
"description": "Extensions for kind",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The date (and optionally time) when the naming system was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the naming system changes.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the organization or individual that published the naming system.",
"$ref": "#/definitions/string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
},
"type": "array"
},
"responsible": {
"description": "The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.",
"$ref": "#/definitions/string"
},
"_responsible": {
"description": "Extensions for responsible",
"$ref": "Element.schema.json#/definitions/Element"
},
"type": {
"description": "Categorizes a naming system for easier search by grouping related naming systems.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"description": {
"description": "A free text natural language description of the naming system from a consumer\u0027s perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc.",
"$ref": "#/definitions/markdown"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate naming system instances.",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
},
"type": "array"
},
"jurisdiction": {
"description": "A legal or geographic region in which the naming system is intended to be used.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"usage": {
"description": "Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.",
"$ref": "#/definitions/string"
},
"_usage": {
"description": "Extensions for usage",
"$ref": "Element.schema.json#/definitions/Element"
},
"uniqueId": {
"description": "Indicates how the system may be identified when referenced in electronic exchange.",
"items": {
"$ref": "#/definitions/NamingSystem_UniqueId"
},
"type": "array"
}
},
"additionalProperties": false,
"required": [
"uniqueId",
"resourceType"
]
},
"NamingSystem_UniqueId": {
"description": "A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a \"System\" used within the Identifier and Coding data types.",
"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"
},
"type": {
"description": "Identifies the unique identifier scheme used for this particular identifier.",
"$ref": "#/definitions/code"
},
"_type": {
"description": "Extensions for type",
"$ref": "Element.schema.json#/definitions/Element"
},
"value": {
"description": "The string that should be sent over the wire to identify the code system or identifier system.",
"$ref": "#/definitions/string"
},
"_value": {
"description": "Extensions for value",
"$ref": "Element.schema.json#/definitions/Element"
},
"preferred": {
"description": "Indicates whether this identifier is the \"preferred\" identifier of this type.",
"$ref": "#/definitions/boolean"
},
"_preferred": {
"description": "Extensions for preferred",
"$ref": "Element.schema.json#/definitions/Element"
},
"comment": {
"description": "Notes about the past or intended usage of this identifier.",
"$ref": "#/definitions/string"
},
"_comment": {
"description": "Extensions for comment",
"$ref": "Element.schema.json#/definitions/Element"
},
"period": {
"description": "Identifies the period of time over which this identifier is considered appropriate to refer to the naming system. Outside of this window, the identifier might be non-deterministic.",
"$ref": "Period.schema.json#/definitions/Period"
}
},
"additionalProperties": false
}
}
}
FHIR ®© HL7.org 2011+. FHIR R4B Ballot #1 hl7.fhir.core#4.3.0-snapshot1 generated on Mon, Dec 20, 2021 14:14+1100.
Links: Search |
Version History |
Table of Contents |
QA Page |
Compare to R4 |
|
Propose a change