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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	NamingSystem	This is a NamingSystem resource
name	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.
status	string	draft\|active\|retired\|unknown	The status of this naming system. Enables tracking the life-cycle of the content.
kind	string	codesystem\|identifier\|root	Indicates the purpose for the naming system - what kinds of things does it make unique?
date	string		The 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.
publisher	string		The name of the individual or organization that published the naming system.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
responsible	string		The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
type	CodeableConcept		Categorizes a naming system for easier search by grouping related naming systems.
description	string		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.
useContext	array(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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the naming system is intended to be used.
usage	string		Provides 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.
replacedBy	Reference		For naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

201 400 401 404

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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	NamingSystem	This is a NamingSystem resource
name	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.
status	string	draft\|active\|retired\|unknown	The status of this naming system. Enables tracking the life-cycle of the content.
kind	string	codesystem\|identifier\|root	Indicates the purpose for the naming system - what kinds of things does it make unique?
date	string		The 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.
publisher	string		The name of the individual or organization that published the naming system.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
responsible	string		The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
type	CodeableConcept		Categorizes a naming system for easier search by grouping related naming systems.
description	string		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.
useContext	array(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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the naming system is intended to be used.
usage	string		Provides 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.
replacedBy	Reference		For naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

200 201 400 401 404 409

Read Naming System

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Naming System

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Naming System

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Naming System

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Naming System

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
contact	string
date	string
description	string
id-type	string
jurisdiction	string
kind	string
name	string
period	string
publisher	string
replaced-by	string
responsible	string
status	string
telecom	string
type	string
value	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Naming System

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
contact	string
date	string
description	string
id-type	string
jurisdiction	string
kind	string
name	string
period	string
publisher	string
replaced-by	string
responsible	string
status	string
telecom	string
type	string
value	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	NamingSystem	This is a NamingSystem resource
name	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.
status	string	draft\|active\|retired\|unknown	The status of this naming system. Enables tracking the life-cycle of the content.
kind	string	codesystem\|identifier\|root	Indicates the purpose for the naming system - what kinds of things does it make unique?
date	string		The 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.
publisher	string		The name of the individual or organization that published the naming system.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
responsible	string		The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
type	CodeableConcept		Categorizes a naming system for easier search by grouping related naming systems.
description	string		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.
useContext	array(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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the naming system is intended to be used.
usage	string		Provides 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.
replacedBy	Reference		For naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

200 401 404

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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	NamingSystem	This is a NamingSystem resource
name	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.
status	string	draft\|active\|retired\|unknown	The status of this naming system. Enables tracking the life-cycle of the content.
kind	string	codesystem\|identifier\|root	Indicates the purpose for the naming system - what kinds of things does it make unique?
date	string		The 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.
publisher	string		The name of the individual or organization that published the naming system.
contact	array(ContactDetail)		Contact details to assist a user in finding and communicating with the publisher.
responsible	string		The name of the organization that is responsible for issuing identifiers or codes for this namespace and ensuring their non-collision.
type	CodeableConcept		Categorizes a naming system for easier search by grouping related naming systems.
description	string		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.
useContext	array(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.
jurisdiction	array(CodeableConcept)		A legal or geographic region in which the naming system is intended to be used.
usage	string		Provides 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.
replacedBy	Reference		For naming systems that are retired, indicates the naming system that should be used in their place (if any).

Response

200 201 400 401 404 409