expansion profiles

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

Resource to define constraints on the Expansion of a FHIR ValueSet.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringExpansionProfileThis is a ExpansionProfile resource
urlstringAn absolute URI that is used to identify this expansion profile 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 expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this expansion profile 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 expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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 expansion profile. 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 expansion profile. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this expansion profile 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 expansion profile 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 expansion profile changes.
publisherstringThe name of the individual or organization that published the expansion profile.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the expansion profile 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 expansion profile instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the expansion profile is intended to be used.
fixedVersionarray(ExpansionProfile_FixedVersion)Fix use of a particular code system to a particular version.
excludedSystemExpansionProfile_ExcludedSystemCode system, or a particular version of a code system to be excluded from value set expansions.
includeDesignationsbooleanControls whether concept designations are to be included or excluded in value set expansions.
designationExpansionProfile_DesignationA set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
includeDefinitionbooleanControls whether the value set definition is included or excluded in value set expansions.
activeOnlybooleanControls whether inactive concepts are included or excluded in value set expansions.
excludeNestedbooleanControls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
excludeNotForUIbooleanControls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
excludePostCoordinatedbooleanControls whether or not the value set expansion includes post coordinated codes.
displayLanguagestringSpecifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
limitedExpansionbooleanIf the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).

Response

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

Resource to define constraints on the Expansion of a FHIR ValueSet.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringExpansionProfileThis is a ExpansionProfile resource
urlstringAn absolute URI that is used to identify this expansion profile 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 expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this expansion profile 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 expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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 expansion profile. 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 expansion profile. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this expansion profile 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 expansion profile 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 expansion profile changes.
publisherstringThe name of the individual or organization that published the expansion profile.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the expansion profile 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 expansion profile instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the expansion profile is intended to be used.
fixedVersionarray(ExpansionProfile_FixedVersion)Fix use of a particular code system to a particular version.
excludedSystemExpansionProfile_ExcludedSystemCode system, or a particular version of a code system to be excluded from value set expansions.
includeDesignationsbooleanControls whether concept designations are to be included or excluded in value set expansions.
designationExpansionProfile_DesignationA set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
includeDefinitionbooleanControls whether the value set definition is included or excluded in value set expansions.
activeOnlybooleanControls whether inactive concepts are included or excluded in value set expansions.
excludeNestedbooleanControls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
excludeNotForUIbooleanControls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
excludePostCoordinatedbooleanControls whether or not the value set expansion includes post coordinated codes.
displayLanguagestringSpecifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
limitedExpansionbooleanIf the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

get
/organizations/{organizationId}/fhir/3/expansionprofile/{resourceId}/_history/{versionId}

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

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

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

Resource to define constraints on the Expansion of a FHIR ValueSet.

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
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringExpansionProfileThis is a ExpansionProfile resource
urlstringAn absolute URI that is used to identify this expansion profile 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 expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this expansion profile 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 expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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 expansion profile. 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 expansion profile. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this expansion profile 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 expansion profile 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 expansion profile changes.
publisherstringThe name of the individual or organization that published the expansion profile.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the expansion profile 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 expansion profile instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the expansion profile is intended to be used.
fixedVersionarray(ExpansionProfile_FixedVersion)Fix use of a particular code system to a particular version.
excludedSystemExpansionProfile_ExcludedSystemCode system, or a particular version of a code system to be excluded from value set expansions.
includeDesignationsbooleanControls whether concept designations are to be included or excluded in value set expansions.
designationExpansionProfile_DesignationA set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
includeDefinitionbooleanControls whether the value set definition is included or excluded in value set expansions.
activeOnlybooleanControls whether inactive concepts are included or excluded in value set expansions.
excludeNestedbooleanControls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
excludeNotForUIbooleanControls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
excludePostCoordinatedbooleanControls whether or not the value set expansion includes post coordinated codes.
displayLanguagestringSpecifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
limitedExpansionbooleanIf the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).

Response

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

Resource to define constraints on the Expansion of a FHIR ValueSet.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringExpansionProfileThis is a ExpansionProfile resource
urlstringAn absolute URI that is used to identify this expansion profile 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 expansion profile is (or will be) published. The URL SHOULD include the major version of the expansion profile. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this expansion profile 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 expansion profile when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the expansion profile 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 expansion profile. 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 expansion profile. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this expansion profile 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 expansion profile 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 expansion profile changes.
publisherstringThe name of the individual or organization that published the expansion profile.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the expansion profile 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 expansion profile instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the expansion profile is intended to be used.
fixedVersionarray(ExpansionProfile_FixedVersion)Fix use of a particular code system to a particular version.
excludedSystemExpansionProfile_ExcludedSystemCode system, or a particular version of a code system to be excluded from value set expansions.
includeDesignationsbooleanControls whether concept designations are to be included or excluded in value set expansions.
designationExpansionProfile_DesignationA set of criteria that provide the constraints imposed on the value set expansion by including or excluding designations.
includeDefinitionbooleanControls whether the value set definition is included or excluded in value set expansions.
activeOnlybooleanControls whether inactive concepts are included or excluded in value set expansions.
excludeNestedbooleanControls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains).
excludeNotForUIbooleanControls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.
excludePostCoordinatedbooleanControls whether or not the value set expansion includes post coordinated codes.
displayLanguagestringSpecifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.
limitedExpansionbooleanIf the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete, using the extension [http://hl7.org/fhir/StructureDefinition/valueset-toocostly](extension-valueset-toocostly.html).

Response