NamingSystem
| Property | Value |
|---|---|
| Publisher | |
| Name | NamingSystem |
| URL | http://hl7.org/fhir/StructureDefinition/NamingSystem |
| Status | draft |
| Description | |
| Abstract | false |
Structure
| Path | Cardinality | Type | Description |
|---|---|---|---|
| NamingSystem | 0..* | NamingSystem | 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. |
| NamingSystem.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| NamingSystem.meta | 0..1 | Meta | 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. |
| NamingSystem.implicitRules | 0..1 | uri | 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. |
| NamingSystem.language | 0..1 | code | The base language in which the resource is written. |
| NamingSystem.text | 0..1 | Narrative | 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. |
| NamingSystem.contained | 0..* | Resource | 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. |
| NamingSystem.extension | 0..* | Extension | 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. |
| NamingSystem.modifierExtension | 0..* | Extension | 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's 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| NamingSystem.name | 1..1 | string | 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. |
| NamingSystem.status | 1..1 | code | The status of this naming system. Enables tracking the life-cycle of the content. |
| NamingSystem.kind | 1..1 | code | Indicates the purpose for the naming system - what kinds of things does it make unique? |
| NamingSystem.date | 1..1 | dateTime | 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. |
| NamingSystem.publisher | 0..1 | string | The name of the organization or individual that published the naming system. |
| NamingSystem.contact | 0..* | ContactDetail | Contact details to assist a user in finding and communicating with the publisher. |
| NamingSystem.responsible | 0..1 | string | The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision. |
| NamingSystem.type | 0..1 | CodeableConcept | Categorizes a naming system for easier search by grouping related naming systems. |
| NamingSystem.description | 0..1 | markdown | A free text natural language description of the naming system from a consumer's perspective. Details about what the namespace identifies including scope, granularity, version labeling, etc. |
| NamingSystem.useContext | 0..* | UsageContext | 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. |
| NamingSystem.jurisdiction | 0..* | CodeableConcept | A legal or geographic region in which the naming system is intended to be used. |
| NamingSystem.usage | 0..1 | string | Provides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc. |
| NamingSystem.uniqueId | 1..* | BackboneElement | Indicates how the system may be identified when referenced in electronic exchange. |
| NamingSystem.uniqueId.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| NamingSystem.uniqueId.extension | 0..* | Extension | 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. |
| NamingSystem.uniqueId.modifierExtension | 0..* | Extension | 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's 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| NamingSystem.uniqueId.type | 1..1 | code | Identifies the unique identifier scheme used for this particular identifier. |
| NamingSystem.uniqueId.value | 1..1 | string | The string that should be sent over the wire to identify the code system or identifier system. |
| NamingSystem.uniqueId.preferred | 0..1 | boolean | Indicates whether this identifier is the "preferred" identifier of this type. |
| NamingSystem.uniqueId.comment | 0..1 | string | Notes about the past or intended usage of this identifier. |
| NamingSystem.uniqueId.period | 0..1 | Period | 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. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| _text | string | Search on the narrative of the resource | |
| _content | string | Search on the entire content of the resource | |
| _filter | token | Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details | |
| _has | string | Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation | |
| _id | token | Logical id of this artifact | Resource.id |
| _lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
| _list | string | All resources in nominated list (by id, Type/id, url or one of the magic List types) | |
| _profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
| _query | token | A custom search profile that describes a specific defined query operation | |
| _security | token | Security Labels applied to this resource | Resource.meta.security |
| _source | uri | Identifies where the resource comes from | Resource.meta.source |
| _tag | token | Tags applied to this resource | Resource.meta.tag |
| _text | string | Search on the narrative text (html) of the resource | |
| _type | token | Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion | |
| context | token | Multiple Resources: * CapabilityStatement: A use context assigned to the capability statement* CodeSystem: A use context assigned to the code system* CompartmentDefinition: A use context assigned to the compartment definition* ConceptMap: A use context assigned to the concept map* GraphDefinition: A use context assigned to the graph definition* ImplementationGuide: A use context assigned to the implementation guide* MessageDefinition: A use context assigned to the message definition* NamingSystem: A use context assigned to the naming system* OperationDefinition: A use context assigned to the operation definition* SearchParameter: A use context assigned to the search parameter* StructureDefinition: A use context assigned to the structure definition* StructureMap: A use context assigned to the structure map* TerminologyCapabilities: A use context assigned to the terminology capabilities* ValueSet: A use context assigned to the value set | (CapabilityStatement.useContext.value.ofType(CodeableConcept)) / (CodeSystem.useContext.value.ofType(CodeableConcept)) / (CompartmentDefinition.useContext.value.ofType(CodeableConcept)) / (ConceptMap.useContext.value.ofType(CodeableConcept)) / (GraphDefinition.useContext.value.ofType(CodeableConcept)) / (ImplementationGuide.useContext.value.ofType(CodeableConcept)) / (MessageDefinition.useContext.value.ofType(CodeableConcept)) / (NamingSystem.useContext.value.ofType(CodeableConcept)) / (OperationDefinition.useContext.value.ofType(CodeableConcept)) / (SearchParameter.useContext.value.ofType(CodeableConcept)) / (StructureDefinition.useContext.value.ofType(CodeableConcept)) / (StructureMap.useContext.value.ofType(CodeableConcept)) / (TerminologyCapabilities.useContext.value.ofType(CodeableConcept)) / (ValueSet.useContext.value.ofType(CodeableConcept)) |
| context-quantity | quantity | Multiple Resources: * CapabilityStatement: A quantity- or range-valued use context assigned to the capability statement* CodeSystem: A quantity- or range-valued use context assigned to the code system* CompartmentDefinition: A quantity- or range-valued use context assigned to the compartment definition* ConceptMap: A quantity- or range-valued use context assigned to the concept map* GraphDefinition: A quantity- or range-valued use context assigned to the graph definition* ImplementationGuide: A quantity- or range-valued use context assigned to the implementation guide* MessageDefinition: A quantity- or range-valued use context assigned to the message definition* NamingSystem: A quantity- or range-valued use context assigned to the naming system* OperationDefinition: A quantity- or range-valued use context assigned to the operation definition* SearchParameter: A quantity- or range-valued use context assigned to the search parameter* StructureDefinition: A quantity- or range-valued use context assigned to the structure definition* StructureMap: A quantity- or range-valued use context assigned to the structure map* TerminologyCapabilities: A quantity- or range-valued use context assigned to the terminology capabilities* ValueSet: A quantity- or range-valued use context assigned to the value set | (CapabilityStatement.useContext.value.ofType(Quantity)) / (CapabilityStatement.useContext.value.ofType(Range)) / (CodeSystem.useContext.value.ofType(Quantity)) / (CodeSystem.useContext.value.ofType(Range)) / (CompartmentDefinition.useContext.value.ofType(Quantity)) / (CompartmentDefinition.useContext.value.ofType(Range)) / (ConceptMap.useContext.value.ofType(Quantity)) / (ConceptMap.useContext.value.ofType(Range)) / (GraphDefinition.useContext.value.ofType(Quantity)) / (GraphDefinition.useContext.value.ofType(Range)) / (ImplementationGuide.useContext.value.ofType(Quantity)) / (ImplementationGuide.useContext.value.ofType(Range)) / (MessageDefinition.useContext.value.ofType(Quantity)) / (MessageDefinition.useContext.value.ofType(Range)) / (NamingSystem.useContext.value.ofType(Quantity)) / (NamingSystem.useContext.value.ofType(Range)) / (OperationDefinition.useContext.value.ofType(Quantity)) / (OperationDefinition.useContext.value.ofType(Range)) / (SearchParameter.useContext.value.ofType(Quantity)) / (SearchParameter.useContext.value.ofType(Range)) / (StructureDefinition.useContext.value.ofType(Quantity)) / (StructureDefinition.useContext.value.ofType(Range)) / (StructureMap.useContext.value.ofType(Quantity)) / (StructureMap.useContext.value.ofType(Range)) / (TerminologyCapabilities.useContext.value.ofType(Quantity)) / (TerminologyCapabilities.useContext.value.ofType(Range)) / (ValueSet.useContext.value.ofType(Quantity)) / (ValueSet.useContext.value.ofType(Range)) |
| context-type | token | Multiple Resources: * CapabilityStatement: A type of use context assigned to the capability statement* CodeSystem: A type of use context assigned to the code system* CompartmentDefinition: A type of use context assigned to the compartment definition* ConceptMap: A type of use context assigned to the concept map* GraphDefinition: A type of use context assigned to the graph definition* ImplementationGuide: A type of use context assigned to the implementation guide* MessageDefinition: A type of use context assigned to the message definition* NamingSystem: A type of use context assigned to the naming system* OperationDefinition: A type of use context assigned to the operation definition* SearchParameter: A type of use context assigned to the search parameter* StructureDefinition: A type of use context assigned to the structure definition* StructureMap: A type of use context assigned to the structure map* TerminologyCapabilities: A type of use context assigned to the terminology capabilities* ValueSet: A type of use context assigned to the value set | CapabilityStatement.useContext.code / CodeSystem.useContext.code / CompartmentDefinition.useContext.code / ConceptMap.useContext.code / GraphDefinition.useContext.code / ImplementationGuide.useContext.code / MessageDefinition.useContext.code / NamingSystem.useContext.code / OperationDefinition.useContext.code / SearchParameter.useContext.code / StructureDefinition.useContext.code / StructureMap.useContext.code / TerminologyCapabilities.useContext.code / ValueSet.useContext.code |
| date | date | Multiple Resources: * CapabilityStatement: The capability statement publication date* CodeSystem: The code system publication date* CompartmentDefinition: The compartment definition publication date* ConceptMap: The concept map publication date* GraphDefinition: The graph definition publication date* ImplementationGuide: The implementation guide publication date* MessageDefinition: The message definition publication date* NamingSystem: The naming system publication date* OperationDefinition: The operation definition publication date* SearchParameter: The search parameter publication date* StructureDefinition: The structure definition publication date* StructureMap: The structure map publication date* TerminologyCapabilities: The terminology capabilities publication date* ValueSet: The value set publication date | CapabilityStatement.date / CodeSystem.date / CompartmentDefinition.date / ConceptMap.date / GraphDefinition.date / ImplementationGuide.date / MessageDefinition.date / NamingSystem.date / OperationDefinition.date / SearchParameter.date / StructureDefinition.date / StructureMap.date / TerminologyCapabilities.date / ValueSet.date |
| description | string | Multiple Resources: * CapabilityStatement: The description of the capability statement* CodeSystem: The description of the code system* CompartmentDefinition: The description of the compartment definition* ConceptMap: The description of the concept map* GraphDefinition: The description of the graph definition* ImplementationGuide: The description of the implementation guide* MessageDefinition: The description of the message definition* NamingSystem: The description of the naming system* OperationDefinition: The description of the operation definition* SearchParameter: The description of the search parameter* StructureDefinition: The description of the structure definition* StructureMap: The description of the structure map* TerminologyCapabilities: The description of the terminology capabilities* ValueSet: The description of the value set | CapabilityStatement.description / CodeSystem.description / CompartmentDefinition.description / ConceptMap.description / GraphDefinition.description / ImplementationGuide.description / MessageDefinition.description / NamingSystem.description / OperationDefinition.description / SearchParameter.description / StructureDefinition.description / StructureMap.description / TerminologyCapabilities.description / ValueSet.description |
| jurisdiction | token | Multiple Resources: * CapabilityStatement: Intended jurisdiction for the capability statement* CodeSystem: Intended jurisdiction for the code system* ConceptMap: Intended jurisdiction for the concept map* GraphDefinition: Intended jurisdiction for the graph definition* ImplementationGuide: Intended jurisdiction for the implementation guide* MessageDefinition: Intended jurisdiction for the message definition* NamingSystem: Intended jurisdiction for the naming system* OperationDefinition: Intended jurisdiction for the operation definition* SearchParameter: Intended jurisdiction for the search parameter* StructureDefinition: Intended jurisdiction for the structure definition* StructureMap: Intended jurisdiction for the structure map* TerminologyCapabilities: Intended jurisdiction for the terminology capabilities* ValueSet: Intended jurisdiction for the value set | CapabilityStatement.jurisdiction / CodeSystem.jurisdiction / ConceptMap.jurisdiction / GraphDefinition.jurisdiction / ImplementationGuide.jurisdiction / MessageDefinition.jurisdiction / NamingSystem.jurisdiction / OperationDefinition.jurisdiction / SearchParameter.jurisdiction / StructureDefinition.jurisdiction / StructureMap.jurisdiction / TerminologyCapabilities.jurisdiction / ValueSet.jurisdiction |
| name | string | Multiple Resources: * CapabilityStatement: Computationally friendly name of the capability statement* CodeSystem: Computationally friendly name of the code system* CompartmentDefinition: Computationally friendly name of the compartment definition* ConceptMap: Computationally friendly name of the concept map* GraphDefinition: Computationally friendly name of the graph definition* ImplementationGuide: Computationally friendly name of the implementation guide* MessageDefinition: Computationally friendly name of the message definition* NamingSystem: Computationally friendly name of the naming system* OperationDefinition: Computationally friendly name of the operation definition* SearchParameter: Computationally friendly name of the search parameter* StructureDefinition: Computationally friendly name of the structure definition* StructureMap: Computationally friendly name of the structure map* TerminologyCapabilities: Computationally friendly name of the terminology capabilities* ValueSet: Computationally friendly name of the value set | CapabilityStatement.name / CodeSystem.name / CompartmentDefinition.name / ConceptMap.name / GraphDefinition.name / ImplementationGuide.name / MessageDefinition.name / NamingSystem.name / OperationDefinition.name / SearchParameter.name / StructureDefinition.name / StructureMap.name / TerminologyCapabilities.name / ValueSet.name |
| publisher | string | Multiple Resources: * CapabilityStatement: Name of the publisher of the capability statement* CodeSystem: Name of the publisher of the code system* CompartmentDefinition: Name of the publisher of the compartment definition* ConceptMap: Name of the publisher of the concept map* GraphDefinition: Name of the publisher of the graph definition* ImplementationGuide: Name of the publisher of the implementation guide* MessageDefinition: Name of the publisher of the message definition* NamingSystem: Name of the publisher of the naming system* OperationDefinition: Name of the publisher of the operation definition* SearchParameter: Name of the publisher of the search parameter* StructureDefinition: Name of the publisher of the structure definition* StructureMap: Name of the publisher of the structure map* TerminologyCapabilities: Name of the publisher of the terminology capabilities* ValueSet: Name of the publisher of the value set | CapabilityStatement.publisher / CodeSystem.publisher / CompartmentDefinition.publisher / ConceptMap.publisher / GraphDefinition.publisher / ImplementationGuide.publisher / MessageDefinition.publisher / NamingSystem.publisher / OperationDefinition.publisher / SearchParameter.publisher / StructureDefinition.publisher / StructureMap.publisher / TerminologyCapabilities.publisher / ValueSet.publisher |
| status | token | Multiple Resources: * CapabilityStatement: The current status of the capability statement* CodeSystem: The current status of the code system* CompartmentDefinition: The current status of the compartment definition* ConceptMap: The current status of the concept map* GraphDefinition: The current status of the graph definition* ImplementationGuide: The current status of the implementation guide* MessageDefinition: The current status of the message definition* NamingSystem: The current status of the naming system* OperationDefinition: The current status of the operation definition* SearchParameter: The current status of the search parameter* StructureDefinition: The current status of the structure definition* StructureMap: The current status of the structure map* TerminologyCapabilities: The current status of the terminology capabilities* ValueSet: The current status of the value set | CapabilityStatement.status / CodeSystem.status / CompartmentDefinition.status / ConceptMap.status / GraphDefinition.status / ImplementationGuide.status / MessageDefinition.status / NamingSystem.status / OperationDefinition.status / SearchParameter.status / StructureDefinition.status / StructureMap.status / TerminologyCapabilities.status / ValueSet.status |
| context-type-quantity | composite | Multiple Resources: * CapabilityStatement: A use context type and quantity- or range-based value assigned to the capability statement* CodeSystem: A use context type and quantity- or range-based value assigned to the code system* CompartmentDefinition: A use context type and quantity- or range-based value assigned to the compartment definition* ConceptMap: A use context type and quantity- or range-based value assigned to the concept map* GraphDefinition: A use context type and quantity- or range-based value assigned to the graph definition* ImplementationGuide: A use context type and quantity- or range-based value assigned to the implementation guide* MessageDefinition: A use context type and quantity- or range-based value assigned to the message definition* NamingSystem: A use context type and quantity- or range-based value assigned to the naming system* OperationDefinition: A use context type and quantity- or range-based value assigned to the operation definition* SearchParameter: A use context type and quantity- or range-based value assigned to the search parameter* StructureDefinition: A use context type and quantity- or range-based value assigned to the structure definition* StructureMap: A use context type and quantity- or range-based value assigned to the structure map* TerminologyCapabilities: A use context type and quantity- or range-based value assigned to the terminology capabilities* ValueSet: A use context type and quantity- or range-based value assigned to the value set | CapabilityStatement.useContext / CodeSystem.useContext / CompartmentDefinition.useContext / ConceptMap.useContext / GraphDefinition.useContext / ImplementationGuide.useContext / MessageDefinition.useContext / NamingSystem.useContext / OperationDefinition.useContext / SearchParameter.useContext / StructureDefinition.useContext / StructureMap.useContext / TerminologyCapabilities.useContext / ValueSet.useContext |
| context-type-value | composite | Multiple Resources: * CapabilityStatement: A use context type and value assigned to the capability statement* CodeSystem: A use context type and value assigned to the code system* CompartmentDefinition: A use context type and value assigned to the compartment definition* ConceptMap: A use context type and value assigned to the concept map* GraphDefinition: A use context type and value assigned to the graph definition* ImplementationGuide: A use context type and value assigned to the implementation guide* MessageDefinition: A use context type and value assigned to the message definition* NamingSystem: A use context type and value assigned to the naming system* OperationDefinition: A use context type and value assigned to the operation definition* SearchParameter: A use context type and value assigned to the search parameter* StructureDefinition: A use context type and value assigned to the structure definition* StructureMap: A use context type and value assigned to the structure map* TerminologyCapabilities: A use context type and value assigned to the terminology capabilities* ValueSet: A use context type and value assigned to the value set | CapabilityStatement.useContext / CodeSystem.useContext / CompartmentDefinition.useContext / ConceptMap.useContext / GraphDefinition.useContext / ImplementationGuide.useContext / MessageDefinition.useContext / NamingSystem.useContext / OperationDefinition.useContext / SearchParameter.useContext / StructureDefinition.useContext / StructureMap.useContext / TerminologyCapabilities.useContext / ValueSet.useContext |
| contact | string | Name of an individual to contact | NamingSystem.contact.name |
| id-type | token | oid / uuid / uri / other | NamingSystem.uniqueId.type |
| kind | token | codesystem / identifier / root | NamingSystem.kind |
| period | date | When is identifier valid? | NamingSystem.uniqueId.period |
| responsible | string | Who maintains system namespace? | NamingSystem.responsible |
| telecom | token | Contact details for individual or organization | NamingSystem.contact.telecom |
| type | token | e.g. driver, provider, patient, bank etc. | NamingSystem.type |
| value | string | The unique identifier | NamingSystem.uniqueId.value |