implementation guides

Create Implementation Guide

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

A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringImplementationGuideThis is a ImplementationGuide resource
urlstringAn absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 implementation guide. 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 implementation guide. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this implementation guide 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 implementation guide 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 implementation guide changes.
publisherstringThe name of the individual or organization that published the implementation guide.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the implementation guide 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 implementation guide instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the implementation guide is intended to be used.
copyrightstringA copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
fhirVersionstringThe version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
dependencyarray(ImplementationGuide_Dependency)Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
packagearray(ImplementationGuide_Package)A logical group of resources. Logical groups can be used when building pages.
globalarray(ImplementationGuide_Global)A set of profiles that all resources covered by this implementation guide must conform to.
binaryarray()A binary file that is included in the implementation guide when it is published.
pageImplementationGuide_PageA page / section in the implementation guide. The root page is the implementation guide home page.

Response

Patch Implementation Guide

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

A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImplementationGuideThis is a ImplementationGuide resource
urlstringAn absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 implementation guide. 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 implementation guide. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this implementation guide 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 implementation guide 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 implementation guide changes.
publisherstringThe name of the individual or organization that published the implementation guide.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the implementation guide 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 implementation guide instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the implementation guide is intended to be used.
copyrightstringA copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
fhirVersionstringThe version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
dependencyarray(ImplementationGuide_Dependency)Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
packagearray(ImplementationGuide_Package)A logical group of resources. Logical groups can be used when building pages.
globalarray(ImplementationGuide_Global)A set of profiles that all resources covered by this implementation guide must conform to.
binaryarray()A binary file that is included in the implementation guide when it is published.
pageImplementationGuide_PageA page / section in the implementation guide. The root page is the implementation guide home page.

Response

Read Implementation Guide

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Implementation Guide

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

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Implementation Guide

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Implementation Guide

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Implementation Guide

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
dependencystring
descriptionstring
experimentalstring
jurisdictionstring
namestring
publisherstring
resourcestring
statusstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Implementation Guide

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

Request

Headers

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

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Implementation Guide

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

A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

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
dependencystring
descriptionstring
experimentalstring
jurisdictionstring
namestring
publisherstring
resourcestring
statusstring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringImplementationGuideThis is a ImplementationGuide resource
urlstringAn absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 implementation guide. 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 implementation guide. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this implementation guide 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 implementation guide 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 implementation guide changes.
publisherstringThe name of the individual or organization that published the implementation guide.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the implementation guide 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 implementation guide instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the implementation guide is intended to be used.
copyrightstringA copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
fhirVersionstringThe version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
dependencyarray(ImplementationGuide_Dependency)Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
packagearray(ImplementationGuide_Package)A logical group of resources. Logical groups can be used when building pages.
globalarray(ImplementationGuide_Global)A set of profiles that all resources covered by this implementation guide must conform to.
binaryarray()A binary file that is included in the implementation guide when it is published.
pageImplementationGuide_PageA page / section in the implementation guide. The root page is the implementation guide home page.

Response

Update Implementation Guide

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

A set of rules of how FHIR is used to solve a particular problem. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImplementationGuideThis is a ImplementationGuide resource
urlstringAn absolute URI that is used to identify this implementation guide 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 implementation guide is (or will be) published. The URL SHOULD include the major version of the implementation guide. For more information see [Technical and Business Versions](resource.html#versions).
versionstringThe identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 implementation guide. 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 implementation guide. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this implementation guide 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 implementation guide 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 implementation guide changes.
publisherstringThe name of the individual or organization that published the implementation guide.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the implementation guide 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 implementation guide instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the implementation guide is intended to be used.
copyrightstringA copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.
fhirVersionstringThe version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.0.1 for this version.
dependencyarray(ImplementationGuide_Dependency)Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.
packagearray(ImplementationGuide_Package)A logical group of resources. Logical groups can be used when building pages.
globalarray(ImplementationGuide_Global)A set of profiles that all resources covered by this implementation guide must conform to.
binaryarray()A binary file that is included in the implementation guide when it is published.
pageImplementationGuide_PageA page / section in the implementation guide. The root page is the implementation guide home page.

Response