naming systems

Create Naming System

post
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringNamingSystemThis is a NamingSystem resource
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.
statusstringdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindstringcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datestringThe date (and optionally time) when the naming system was published. The date must change if and 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 individual or organization 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.
descriptionstringA 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 terms 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.
replacedByReferenceFor naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

Patch Naming System

patch
/organizations/{organizationId}/fhir/3/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*stringNamingSystemThis is a NamingSystem resource
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.
statusstringdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindstringcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datestringThe date (and optionally time) when the naming system was published. The date must change if and 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 individual or organization 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.
descriptionstringA 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 terms 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.
replacedByReferenceFor naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

Read Naming System

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Naming System

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/NamingSystem/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Naming System

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Naming System

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

Request

Headers

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

Query params

_idstring
_languagestring
contactstring
datestring
descriptionstring
id-typestring
jurisdictionstring
kindstring
namestring
periodstring
publisherstring
replaced-bystring
responsiblestring
statusstring
telecomstring
typestring
valuestring

Params

organizationId*string|stringid|slug

Response

Search History Naming System

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/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
datestring
descriptionstring
id-typestring
jurisdictionstring
kindstring
namestring
periodstring
publisherstring
replaced-bystring
responsiblestring
statusstring
telecomstring
typestring
valuestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringNamingSystemThis is a NamingSystem resource
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.
statusstringdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindstringcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datestringThe date (and optionally time) when the naming system was published. The date must change if and 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 individual or organization 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.
descriptionstringA 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 terms 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.
replacedByReferenceFor naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

Update Naming System

put
/organizations/{organizationId}/fhir/3/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/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringNamingSystemThis is a NamingSystem resource
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.
statusstringdraft|active|retired|unknownThe status of this naming system. Enables tracking the life-cycle of the content.
kindstringcodesystem|identifier|rootIndicates the purpose for the naming system - what kinds of things does it make unique?
datestringThe date (and optionally time) when the naming system was published. The date must change if and 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 individual or organization 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.
descriptionstringA 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 terms 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.
replacedByReferenceFor naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response