Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Procedure

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

Get the dataset for the specified object

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Body
anyOptional
Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/_export

Get the dataset for the specified object

get
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional
Query parameters
methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/{id}/_export

Perform a search (query) for

get

The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_offsetnumberOptional

The offet of the first result to return

_countnumberOptional

The count of items to return in this result set

_includeTotalbooleanOptional

True if the server should count the matching results. May reduce performance

_orderBystringOptional

Instructs the result set to be ordered (in format: property:(asc|desc))

_queryIdstringOptional

The query state identifier. This allows the client to get a stable result set.

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure

Creates the resource. If the resource already exists, then a 409 is thrown

post

This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

post/Procedure

Returns specific options for a single resource

options
Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

options/Procedure

Perform a search (query) and return only the headers

head

The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change

Query parameters
methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
204

There is not response for this method

No content
head/Procedure
No content

Retrieves the current version of the specified resource

get

This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the object which should be retrieved

Query parameters
_bundlebooleanOptional

True if the server should send related objects to the caller in a bundle

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/{id}

Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does

post

This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be created or updated

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

post/Procedure/{id}

Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown

put

This operation will update an existing resource on the server such that the data in the database exactly matches the data passed via the API.

         Note: If you post an incomplete object (such as one missing identifiers, or addresses) then the current resource will have those attributes removed. For partial updates, use the PATCH operation instead.
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be updated

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

put/Procedure/{id}

Deletes the specified resource from the server

delete

This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be deleted

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

delete/Procedure/{id}

Retrieves only the metadata of the specified resource

head

The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.

Path parameters
idstringOptional

The identifier of the resource to be retrieved

Query parameters
methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
204

There is not response for this method

No content
head/Procedure/{id}
No content

Updates the specified resource according to the instructions in the PATCH file

patch

The PATCH operation allows for partial updating of a resource.

         This method must be used in conjunction with an If-Match header indicating the version that you would like apply the patch against.
        
         The server will load the most recent version and compre the version code with If-Match, if the match is successful the instructions in the PATCH are applied to the loaded version.
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to be patched

Body

Represents a series of patch instructions

versionstringOptional

Gets or sets the version of the patch file

appliesToanyOptional

Application version

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

Responses
204

There is not response for this method

No content
patch/Procedure/{id}
No content

Gets a complete history of all changes made to the specified resource

get

The result of the history operation is a

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource to retrieve

Query parameters
_sincestringOptional

The last version of the object that should be returned

_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/{id}/_history

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/{id}/$diff

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/{id}/$tag

Invokes the specified operation

post

In SanteDB an operation or method is invoked using

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The ID of the object which scopes the operation

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/{id}/$validate

Retrieves a specific version of the specified resource

get

This method allows the caller to retrieve a specific version of the identified object, which is useful for loading a previous copy of a resource for reference.

Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource for which history sould be retrieved

versionIdstringOptional

The version of the resource to retrieve

Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/{id}/_history/{versionId}

Gets the specified barcode for the resource

get

This method returns a barcode which explicitly points at the specified resource in the specified authority.

         The barcode is generated using the server's configuration, and is signed by the server's signing key.
        
         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the resource for which a VRP should be generated

Query parameters
_formatstringOptional

The format of the barcode (santedb-vrp, code39, etc.)

methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/{id}/_code

Gets the digitally signed pointer (in JWS format) for the resource

get

This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return the structured contents of that code so the client can best determine how to represent the data.

         For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Read Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstringOptional

The identifier of the object for which the pointer should be created

Query parameters
methodstringOptional

Gets or sets te method/technique used to perform the procedure

approachSitestringOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestringOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestringOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstringOptional

The classification key of the activity

moodConceptstringOptional

The mood (or mode) of the Act instance

reasonConceptstringOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstringOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstringOptional

The concept which describes the current status of the act

typeConceptstringOptional

Gets or sets the key of the concept which further classifies the type of act occurring

identifierstringOptional

Identifiers by which this act is known

relationshipstringOptional

Gets a list of all associated acts for this act

policystringOptional

Gets or sets the security policy instances associated with the act

extensionstringOptional

Gets a list of all extensions associated with the act

notestringOptional

Gets a list of all notes associated with the act

tagstringOptional

Gets a list of all tags associated with the act

protocolstringOptional

Identifies protocols attached to the act

participationstringOptional

Gets or sets the entities and participations they play in the act

geostringOptional

Gets or sets the geo-tag

etagstringOptional

Override the ETag

previousVersionstringOptional

Gets or sets the UUID of the previous version of this record

headbooleanOptional

True if the object is the head version

versionstringOptional

Gets or sets the UUID of the current version of this object

sequencestringOptional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstringOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystringOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystringOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstringOptional

Gets or sets the primary identifying UUID of this object

$selfstringOptional

A query parameter which references itself - this is for query filters which pass the original data in

Responses
200

Operation was completed successfully

Represents a class which has an immediate and primary outcome and is an alteration of the physical condition of the subject.

methodstring · uuidOptional

Gets or sets te method/technique used to perform the procedure

approachSitestring · uuidOptional

Gets or sets the anatomical site or system through which the procedure was performed

targetSitestring · uuidOptional

Gets or sets the anatomical site or system which is the target of the procedure

isNegatedbooleanOptional

Identifies whether the act represented in this instance actually occurred

templatestring · uuidOptional

The template on which the act is based

actTimestringOptional

The moment in time that this act occurred in ISO format

startTimestringOptional

The time when the act should or did start ocurring in ISO format

stopTimestringOptional

The time when the act should or did stop ocurring in ISO format

classConceptstring · uuidOptional

The classification key of the activity

moodConceptstring · uuidOptional

The mood (or mode) of the Act instance

reasonConceptstring · uuidOptional

Identifies a codified reason as to why this act did (or did not, or should or should not) occur.

obsoletionReasonstring · uuidOptional

Gets or sets the reason why the act was obsoleted/deleted

statusConceptstring · uuidOptional

The concept which describes the current status of the act

typeConceptstring · uuidOptional

Gets or sets the key of the concept which further classifies the type of act occurring

geoanyOptional

Gets or sets the geo-tag

previousVersionstring · uuidOptional

Gets or sets the UUID of the previous version of this record

versionstring · uuidOptional

Gets or sets the UUID of the current version of this object

sequencenumber · int64Optional

The sequence number of the version (for ordering)

creationTimestringOptional

Gets or sets the creation time as an ISO date format

obsoletionTimestringOptional

Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format

modifiedOnstring · dateOptional

Gets the time that the object was last modified (from base data, default to CreationTime)

createdBystring · uuidOptional

Gets or sets the security provenance object which represents the creation of this object

obsoletedBystring · uuidOptional

Gets or sets the security provenance object which represents the obsoletion of this data

idstring · uuidOptional

Gets or sets the primary identifying UUID of this object

operationstring · enumOptional

Gets or sets the operation

Possible values:
$typestringOptional

Gets the type registration of this object

get/Procedure/{id}/_ptr

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/$xsd-complete

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/$expand

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/$schema-complete

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/$validate

Invokes the specified operation

post
Required scopes
This endpoint requires the following scopes:
  • : Login as a Service
  • : Write Clinical Data
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
_viewModelstringOptional

When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response

Body

Gets the operation invokation

Responses
200

Operation was completed successfully

object · ObjectOptional
post/Procedure/$xref-use
PreviousPlace ServiceNextProtocol

Last updated

Was this helpful?