naming systems

Create Naming System

post
/organizations/{organizationId}/fhir/4/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.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a NamingSystem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
namestringA 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.
statusdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datedateTimeThe 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.
publisherstringThe name of the organization or individual that published the naming system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
responsiblestringThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
typeCodeableConceptCategorizes a naming system for easier search by grouping related naming systems.
descriptionmarkdownA 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.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the naming system is intended to be used.
usagestringProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
uniqueId*array(NamingSystem_UniqueId)Indicates how the system may be identified when referenced in electronic exchange.

Response

Patch Naming System

patch
/organizations/{organizationId}/fhir/4/NamingSystem/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a NamingSystem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
namestringA 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.
statusdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datedateTimeThe 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.
publisherstringThe name of the organization or individual that published the naming system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
responsiblestringThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
typeCodeableConceptCategorizes a naming system for easier search by grouping related naming systems.
descriptionmarkdownA 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.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the naming system is intended to be used.
usagestringProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
uniqueId*array(NamingSystem_UniqueId)Indicates how the system may be identified when referenced in electronic exchange.

Response

Read Naming System

get
/organizations/{organizationId}/fhir/4/NamingSystem/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Naming System

get
/organizations/{organizationId}/fhir/4/NamingSystem/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Naming System

get
/organizations/{organizationId}/fhir/4/NamingSystem/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Naming System

delete
/organizations/{organizationId}/fhir/4/NamingSystem/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Naming System

get
/organizations/{organizationId}/fhir/4/NamingSystem

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
contactstring
contextstring
context-quantitystring
context-typestring
context-type-quantitystring
context-type-valuestring
datestring
descriptionstring
id-typestring
jurisdictionstring
kindstring
namestring
periodstring
publisherstring
responsiblestring
statusstring
telecomstring
typestring
valuestring

Params

organizationId*string|stringid|slug

Response

Search History Naming System

get
/organizations/{organizationId}/fhir/4/NamingSystem/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Naming System

post
/organizations/{organizationId}/fhir/4/NamingSystem/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
contactstring
contextstring
context-quantitystring
context-typestring
context-type-quantitystring
context-type-valuestring
datestring
descriptionstring
id-typestring
jurisdictionstring
kindstring
namestring
periodstring
publisherstring
responsiblestring
statusstring
telecomstring
typestring
valuestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a NamingSystem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
namestringA 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.
statusdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datedateTimeThe 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.
publisherstringThe name of the organization or individual that published the naming system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
responsiblestringThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
typeCodeableConceptCategorizes a naming system for easier search by grouping related naming systems.
descriptionmarkdownA 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.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the naming system is intended to be used.
usagestringProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
uniqueId*array(NamingSystem_UniqueId)Indicates how the system may be identified when referenced in electronic exchange.

Response

Update Naming System

put
/organizations/{organizationId}/fhir/4/NamingSystem/{resourceId}

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.

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a NamingSystem resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
namestringA 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.
statusdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datedateTimeThe 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.
publisherstringThe name of the organization or individual that published the naming system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
responsiblestringThe name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
typeCodeableConceptCategorizes a naming system for easier search by grouping related naming systems.
descriptionmarkdownA 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.
useContextarray(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.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the naming system is intended to be used.
usagestringProvides guidance on the use of the namespace, including the handling of formatting characters, use of upper vs. lower case, etc.
uniqueId*array(NamingSystem_UniqueId)Indicates how the system may be identified when referenced in electronic exchange.

Response