graph definitions

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

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug

Body

resourceType*stringGraphDefinitionThis is a GraphDefinition resource
urlstringAn absolute URI that is used to identify this graph definition 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 graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this graph definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the graph definition 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 graph definition changes.
publisherstringThe name of the individual or organization that published the graph definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the graph definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the graph definition is intended to be used.
purposestringExplaination of why this graph definition is needed and why it has been designed as it has.
startstringThe type of FHIR resource at which instances of this graph start.
profilestringThe profile that describes the use of the base resource.
linkarray(GraphDefinition_Link)Links this graph makes rules about.

Response

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

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGraphDefinitionThis is a GraphDefinition resource
urlstringAn absolute URI that is used to identify this graph definition 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 graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this graph definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the graph definition 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 graph definition changes.
publisherstringThe name of the individual or organization that published the graph definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the graph definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the graph definition is intended to be used.
purposestringExplaination of why this graph definition is needed and why it has been designed as it has.
startstringThe type of FHIR resource at which instances of this graph start.
profilestringThe profile that describes the use of the base resource.
linkarray(GraphDefinition_Link)Links this graph makes rules about.

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

get
/organizations/{organizationId}/fhir/3/graphdefinition/{resourceId}/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

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

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Response

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
descriptionstring
jurisdictionstring
namestring
publisherstring
startstring
statusstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

get
/organizations/{organizationId}/fhir/3/graphdefinition/_history

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

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

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
descriptionstring
jurisdictionstring
namestring
publisherstring
startstring
statusstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringGraphDefinitionThis is a GraphDefinition resource
urlstringAn absolute URI that is used to identify this graph definition 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 graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this graph definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the graph definition 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 graph definition changes.
publisherstringThe name of the individual or organization that published the graph definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the graph definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the graph definition is intended to be used.
purposestringExplaination of why this graph definition is needed and why it has been designed as it has.
startstringThe type of FHIR resource at which instances of this graph start.
profilestringThe profile that describes the use of the base resource.
linkarray(GraphDefinition_Link)Links this graph makes rules about.

Response

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

A formal computable definition of a graph of resources - that is, a coherent set of resources that form a graph by following references. The Graph Definition resource defines a set and makes rules about the set.

Request

Headers

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

Query params

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringGraphDefinitionThis is a GraphDefinition resource
urlstringAn absolute URI that is used to identify this graph definition 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 graph definition is (or will be) published. The URL SHOULD include the major version of the graph definition. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the graph definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the graph definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
namestringA natural language name identifying the graph definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
statusstringdraft|active|retired|unknownThe status of this graph definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this graph definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
datestringThe date (and optionally time) when the graph definition 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 graph definition changes.
publisherstringThe name of the individual or organization that published the graph definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the graph definition from a consumer's perspective.
useContextarray(UsageContext)The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate graph definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the graph definition is intended to be used.
purposestringExplaination of why this graph definition is needed and why it has been designed as it has.
startstringThe type of FHIR resource at which instances of this graph start.
profilestringThe profile that describes the use of the base resource.
linkarray(GraphDefinition_Link)Links this graph makes rules about.

Response