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* | string | application/json | 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 | DataElement | This is a DataElement resource |
| url | string | An 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). | |
| identifier | array(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. | |
| version | string | The 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. | |
| status | string | draft|active|retired|unknown | The status of this data element. Enables tracking the life-cycle of the content. |
| experimental | boolean | A 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. | |
| date | string | The 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. | |
| publisher | string | The name of the individual or organization that published the data element. | |
| name | string | A 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. | |
| title | string | A short, descriptive, user-friendly title for the data element. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| 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 data element instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the data element is intended to be used. | |
| copyright | string | A 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. | |
| stringency | string | comparable|fully-specified|equivalent|convertable|scaleable|flexible | Identifies how precise the data element is in its definition. |
| mapping | array(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
keyboard_arrow_down
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* | 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 | DataElement | This is a DataElement resource |
| url | string | An 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). | |
| identifier | array(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. | |
| version | string | The 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. | |
| status | string | draft|active|retired|unknown | The status of this data element. Enables tracking the life-cycle of the content. |
| experimental | boolean | A 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. | |
| date | string | The 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. | |
| publisher | string | The name of the individual or organization that published the data element. | |
| name | string | A 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. | |
| title | string | A short, descriptive, user-friendly title for the data element. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| 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 data element instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the data element is intended to be used. | |
| copyright | string | A 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. | |
| stringency | string | comparable|fully-specified|equivalent|convertable|scaleable|flexible | Identifies how precise the data element is in its definition. |
| mapping | array(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
keyboard_arrow_down
Read Data Element
get
/organizations/{organizationId}/fhir/3/DataElement/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Data Element
get
/organizations/{organizationId}/fhir/3/DataElement/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | 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
keyboard_arrow_down
Read Version Data Element
get
/organizations/{organizationId}/fhir/3/DataElement/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | 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
keyboard_arrow_down
Remove Data Element
delete
/organizations/{organizationId}/fhir/3/DataElement/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Data Element
get
/organizations/{organizationId}/fhir/3/DataElement
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| code | string | ||
| date | string | ||
| description | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| publisher | string | ||
| status | string | ||
| stringency | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Data Element
get
/organizations/{organizationId}/fhir/3/DataElement/_history
Request
Headers
| content-type* | string | application/json | 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
keyboard_arrow_down
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* | 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 | ||
| code | string | ||
| date | string | ||
| description | string | ||
| identifier | string | ||
| jurisdiction | string | ||
| name | string | ||
| publisher | string | ||
| status | string | ||
| stringency | string | ||
| title | string | ||
| url | string | ||
| version | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | DataElement | This is a DataElement resource |
| url | string | An 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). | |
| identifier | array(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. | |
| version | string | The 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. | |
| status | string | draft|active|retired|unknown | The status of this data element. Enables tracking the life-cycle of the content. |
| experimental | boolean | A 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. | |
| date | string | The 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. | |
| publisher | string | The name of the individual or organization that published the data element. | |
| name | string | A 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. | |
| title | string | A short, descriptive, user-friendly title for the data element. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| 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 data element instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the data element is intended to be used. | |
| copyright | string | A 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. | |
| stringency | string | comparable|fully-specified|equivalent|convertable|scaleable|flexible | Identifies how precise the data element is in its definition. |
| mapping | array(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
keyboard_arrow_down
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* | string | application/json | 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 | DataElement | This is a DataElement resource |
| url | string | An 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). | |
| identifier | array(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. | |
| version | string | The 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. | |
| status | string | draft|active|retired|unknown | The status of this data element. Enables tracking the life-cycle of the content. |
| experimental | boolean | A 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. | |
| date | string | The 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. | |
| publisher | string | The name of the individual or organization that published the data element. | |
| name | string | A 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. | |
| title | string | A short, descriptive, user-friendly title for the data element. | |
| contact | array(ContactDetail) | Contact details to assist a user in finding and communicating with the publisher. | |
| 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 data element instances. | |
| jurisdiction | array(CodeableConcept) | A legal or geographic region in which the data element is intended to be used. | |
| copyright | string | A 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. | |
| stringency | string | comparable|fully-specified|equivalent|convertable|scaleable|flexible | Identifies how precise the data element is in its definition. |
| mapping | array(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
keyboard_arrow_down