data elements

Create Data Element

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

The formal description of a single piece of information that can be gathered and reported.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringDataElementThis is a DataElement resource
urlstringAn absolute URI that is used to identify this data element 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 data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this data element 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 data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element 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.
statusstringdraft|active|retired|unknownThe status of this data element. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this data element 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 data element 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 data element changes.
publisherstringThe name of the individual or organization that published the data element.
namestringA natural language name identifying the data element. 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 data element.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
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 data element instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the data element is intended to be used.
copyrightstringA copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
stringencystringcomparable|fully-specified|equivalent|convertable|scaleable|flexibleIdentifies how precise the data element is in its definition.
mappingarray(DataElement_Mapping)Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
element*array(ElementDefinition)Defines the structure, type, allowed values and other constraining characteristics of the data element.

Response

Patch Data Element

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

The formal description of a single piece of information that can be gathered and reported.

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*stringDataElementThis is a DataElement resource
urlstringAn absolute URI that is used to identify this data element 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 data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this data element 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 data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element 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.
statusstringdraft|active|retired|unknownThe status of this data element. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this data element 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 data element 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 data element changes.
publisherstringThe name of the individual or organization that published the data element.
namestringA natural language name identifying the data element. 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 data element.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
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 data element instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the data element is intended to be used.
copyrightstringA copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
stringencystringcomparable|fully-specified|equivalent|convertable|scaleable|flexibleIdentifies how precise the data element is in its definition.
mappingarray(DataElement_Mapping)Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
element*array(ElementDefinition)Defines the structure, type, allowed values and other constraining characteristics of the data element.

Response

Read Data Element

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

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

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

delete
/organizations/{organizationId}/fhir/3/DataElement/{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 Data Element

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

Request

Headers

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

Query params

_idstring
_languagestring
codestring
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
stringencystring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Data Element

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

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

The formal description of a single piece of information that can be gathered and reported.

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
datestring
descriptionstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
stringencystring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringDataElementThis is a DataElement resource
urlstringAn absolute URI that is used to identify this data element 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 data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this data element 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 data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element 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.
statusstringdraft|active|retired|unknownThe status of this data element. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this data element 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 data element 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 data element changes.
publisherstringThe name of the individual or organization that published the data element.
namestringA natural language name identifying the data element. 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 data element.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
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 data element instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the data element is intended to be used.
copyrightstringA copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
stringencystringcomparable|fully-specified|equivalent|convertable|scaleable|flexibleIdentifies how precise the data element is in its definition.
mappingarray(DataElement_Mapping)Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
element*array(ElementDefinition)Defines the structure, type, allowed values and other constraining characteristics of the data element.

Response

Update Data Element

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

The formal description of a single piece of information that can be gathered and reported.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringDataElementThis is a DataElement resource
urlstringAn absolute URI that is used to identify this data element 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 data element is (or will be) published. The URL SHOULD include the major version of the data element. For more information see [Technical and Business Versions](resource.html#versions).
identifierarray(Identifier)A formal identifier that is used to identify this data element 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 data element when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the data element 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.
statusstringdraft|active|retired|unknownThe status of this data element. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this data element 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 data element 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 data element changes.
publisherstringThe name of the individual or organization that published the data element.
namestringA natural language name identifying the data element. 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 data element.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
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 data element instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the data element is intended to be used.
copyrightstringA copyright statement relating to the data element and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the data element.
stringencystringcomparable|fully-specified|equivalent|convertable|scaleable|flexibleIdentifies how precise the data element is in its definition.
mappingarray(DataElement_Mapping)Identifies a specification (other than a terminology) that the elements which make up the DataElement have some correspondence with.
element*array(ElementDefinition)Defines the structure, type, allowed values and other constraining characteristics of the data element.

Response