value sets

Create Value Set

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

A value set 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*stringValueSetThis is a ValueSet resource
urlstringAn absolute URI that is used to identify this value set 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 value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this value set 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 value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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.
namestringA natural language name identifying the value set. 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 value set.
statusstringdraft|active|retired|unknownThe status of this value set. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this value set 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 value set 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 value set changes. (e.g. the 'content logical definition').
publisherstringThe name of the individual or organization that published the value set.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the value set 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 value set instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the value set is intended to be used.
immutablebooleanIf this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
purposestringExplaination of why this value set is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
extensiblebooleanWhether this is intended to be used with an extensible binding or not.
composeValueSet_ComposeA set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).
expansionValueSet_ExpansionA value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Response

Patch Value Set

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

A value set 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*stringValueSetThis is a ValueSet resource
urlstringAn absolute URI that is used to identify this value set 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 value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this value set 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 value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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.
namestringA natural language name identifying the value set. 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 value set.
statusstringdraft|active|retired|unknownThe status of this value set. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this value set 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 value set 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 value set changes. (e.g. the 'content logical definition').
publisherstringThe name of the individual or organization that published the value set.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the value set 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 value set instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the value set is intended to be used.
immutablebooleanIf this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
purposestringExplaination of why this value set is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
extensiblebooleanWhether this is intended to be used with an extensible binding or not.
composeValueSet_ComposeA set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).
expansionValueSet_ExpansionA value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Response

Read Value Set

get
/organizations/{organizationId}/fhir/3/ValueSet/{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 Value Set

get
/organizations/{organizationId}/fhir/3/ValueSet/{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 Value Set

get
/organizations/{organizationId}/fhir/3/ValueSet/{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 Value Set

delete
/organizations/{organizationId}/fhir/3/ValueSet/{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 Value Set

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
descriptionstring
expansionstring
identifierstring
jurisdictionstring
namestring
publisherstring
referencestring
statusstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Value Set

get
/organizations/{organizationId}/fhir/3/ValueSet/_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 Value Set

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

A value set 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
datestring
descriptionstring
expansionstring
identifierstring
jurisdictionstring
namestring
publisherstring
referencestring
statusstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringValueSetThis is a ValueSet resource
urlstringAn absolute URI that is used to identify this value set 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 value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this value set 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 value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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.
namestringA natural language name identifying the value set. 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 value set.
statusstringdraft|active|retired|unknownThe status of this value set. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this value set 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 value set 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 value set changes. (e.g. the 'content logical definition').
publisherstringThe name of the individual or organization that published the value set.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the value set 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 value set instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the value set is intended to be used.
immutablebooleanIf this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
purposestringExplaination of why this value set is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
extensiblebooleanWhether this is intended to be used with an extensible binding or not.
composeValueSet_ComposeA set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).
expansionValueSet_ExpansionA value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Response

Update Value Set

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

A value set 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*stringValueSetThis is a ValueSet resource
urlstringAn absolute URI that is used to identify this value set 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 value set is (or will be) published. The URL SHOULD include the major version of the value set. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this value set 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 value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set 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.
namestringA natural language name identifying the value set. 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 value set.
statusstringdraft|active|retired|unknownThe status of this value set. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this value set 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 value set 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 value set changes. (e.g. the 'content logical definition').
publisherstringThe name of the individual or organization that published the value set.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the value set 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 value set instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the value set is intended to be used.
immutablebooleanIf this is set to 'true', then no new versions of the content logical definition can be created. Note: Other metadata might still change.
purposestringExplaination of why this value set is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.
extensiblebooleanWhether this is intended to be used with an extensible binding or not.
composeValueSet_ComposeA set of criteria that define the content logical definition of the value set by including or excluding codes from outside this value set. This I also known as the "Content Logical Definition" (CLD).
expansionValueSet_ExpansionA value set can also be "expanded", where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Response