code systems

Create Code System

post
/organizations/{organizationId}/fhir/3/CodeSystem

A code system resource specifies a set of codes drawn from one or more code systems.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringCodeSystemThis is a CodeSystem resource
urlstringAn absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
identifierIdentifierA formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding]{datatypes.html#Coding}.version.
namestringA natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the code system.
statusstringdraft|active|retired|unknownThe status of this code system. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the code 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 code system changes.
publisherstringThe name of the individual or organization that published the code system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the code system from a consumer's perspective.
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 code system instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the code system is intended to be used.
purposestringExplaination of why this code system is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
caseSensitivebooleanIf code comparison is case sensitive when codes within this system are compared to each other.
valueSetstringCanonical URL of value set that contains the entire code system.
hierarchyMeaningstringgrouped-by|is-a|part-of|classified-withThe meaning of the hierarchy of concepts.
compositionalbooleanTrue If code system defines a post-composition grammar.
versionNeededbooleanThis flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
contentstringnot-present|example|fragment|completeHow much of the content of the code system - the concepts and codes it defines - are represented in this resource.
countnumberThe total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
filterarray(CodeSystem_Filter)A filter that can be used in a value set compose statement when selecting concepts using a filter.
propertyarray(CodeSystem_Property)A property defines an additional slot through which additional information can be provided about a concept.
conceptarray(CodeSystem_Concept)Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.

Response

Patch Code System

patch
/organizations/{organizationId}/fhir/3/CodeSystem/{resourceId}

A code system resource specifies a set of codes drawn from one or more code systems.

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*stringCodeSystemThis is a CodeSystem resource
urlstringAn absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
identifierIdentifierA formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding]{datatypes.html#Coding}.version.
namestringA natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the code system.
statusstringdraft|active|retired|unknownThe status of this code system. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the code 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 code system changes.
publisherstringThe name of the individual or organization that published the code system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the code system from a consumer's perspective.
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 code system instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the code system is intended to be used.
purposestringExplaination of why this code system is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
caseSensitivebooleanIf code comparison is case sensitive when codes within this system are compared to each other.
valueSetstringCanonical URL of value set that contains the entire code system.
hierarchyMeaningstringgrouped-by|is-a|part-of|classified-withThe meaning of the hierarchy of concepts.
compositionalbooleanTrue If code system defines a post-composition grammar.
versionNeededbooleanThis flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
contentstringnot-present|example|fragment|completeHow much of the content of the code system - the concepts and codes it defines - are represented in this resource.
countnumberThe total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
filterarray(CodeSystem_Filter)A filter that can be used in a value set compose statement when selecting concepts using a filter.
propertyarray(CodeSystem_Property)A property defines an additional slot through which additional information can be provided about a concept.
conceptarray(CodeSystem_Concept)Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.

Response

Read Code System

get
/organizations/{organizationId}/fhir/3/CodeSystem/{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 Code System

get
/organizations/{organizationId}/fhir/3/CodeSystem/{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 Code System

get
/organizations/{organizationId}/fhir/3/CodeSystem/{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 Code System

delete
/organizations/{organizationId}/fhir/3/CodeSystem/{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 Code System

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

Request

Headers

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

Query params

_idstring
_languagestring
codestring
content-modestring
datestring
descriptionstring
identifierstring
jurisdictionstring
languagestring
namestring
publisherstring
statusstring
systemstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Code System

get
/organizations/{organizationId}/fhir/3/CodeSystem/_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 Code System

post
/organizations/{organizationId}/fhir/3/CodeSystem/_search

A code system resource specifies a set of codes drawn from one or more code systems.

Request

Headers

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

Query params

_idstring
_languagestring
codestring
content-modestring
datestring
descriptionstring
identifierstring
jurisdictionstring
languagestring
namestring
publisherstring
statusstring
systemstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringCodeSystemThis is a CodeSystem resource
urlstringAn absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
identifierIdentifierA formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding]{datatypes.html#Coding}.version.
namestringA natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the code system.
statusstringdraft|active|retired|unknownThe status of this code system. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the code 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 code system changes.
publisherstringThe name of the individual or organization that published the code system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the code system from a consumer's perspective.
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 code system instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the code system is intended to be used.
purposestringExplaination of why this code system is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
caseSensitivebooleanIf code comparison is case sensitive when codes within this system are compared to each other.
valueSetstringCanonical URL of value set that contains the entire code system.
hierarchyMeaningstringgrouped-by|is-a|part-of|classified-withThe meaning of the hierarchy of concepts.
compositionalbooleanTrue If code system defines a post-composition grammar.
versionNeededbooleanThis flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
contentstringnot-present|example|fragment|completeHow much of the content of the code system - the concepts and codes it defines - are represented in this resource.
countnumberThe total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
filterarray(CodeSystem_Filter)A filter that can be used in a value set compose statement when selecting concepts using a filter.
propertyarray(CodeSystem_Property)A property defines an additional slot through which additional information can be provided about a concept.
conceptarray(CodeSystem_Concept)Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.

Response

Update Code System

put
/organizations/{organizationId}/fhir/3/CodeSystem/{resourceId}

A code system resource specifies a set of codes drawn from one or more code systems.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringCodeSystemThis is a CodeSystem resource
urlstringAn absolute URI that is used to identify this code system when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this code system is (or will be) published. The URL SHOULD include the major version of the code system. For more information see [Technical and Business Versions](resource.html#versions). This is used in [Coding]{datatypes.html#Coding}.system.
identifierIdentifierA formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the code system when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the code system author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. This is used in [Coding]{datatypes.html#Coding}.version.
namestringA natural language name identifying the code system. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the code system.
statusstringdraft|active|retired|unknownThe status of this code system. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this code system is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the code 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 code system changes.
publisherstringThe name of the individual or organization that published the code system.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the code system from a consumer's perspective.
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 code system instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the code system is intended to be used.
purposestringExplaination of why this code system is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the code system and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the code system.
caseSensitivebooleanIf code comparison is case sensitive when codes within this system are compared to each other.
valueSetstringCanonical URL of value set that contains the entire code system.
hierarchyMeaningstringgrouped-by|is-a|part-of|classified-withThe meaning of the hierarchy of concepts.
compositionalbooleanTrue If code system defines a post-composition grammar.
versionNeededbooleanThis flag is used to signify that the code system has not (or does not) maintain the definitions, and a version must be specified when referencing this code system.
contentstringnot-present|example|fragment|completeHow much of the content of the code system - the concepts and codes it defines - are represented in this resource.
countnumberThe total number of concepts defined by the code system. Where the code system has a compositional grammar, the count refers to the number of base (primitive) concepts.
filterarray(CodeSystem_Filter)A filter that can be used in a value set compose statement when selecting concepts using a filter.
propertyarray(CodeSystem_Property)A property defines an additional slot through which additional information can be provided about a concept.
conceptarray(CodeSystem_Concept)Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are.

Response