message definitions

Create Message Definition

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

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*stringMessageDefinitionThis is a MessageDefinition resource
urlstringAn absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the message definition.
statusstringdraft|active|retired|unknownThe status of this message definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this message 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 message 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 message definition changes.
publisherstringThe name of the individual or organization that published the message definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the message 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 message definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the message definition is intended to be used.
purposestringExplaination of why this message definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
baseReferenceThe MessageDefinition that is the basis for the contents of this resource.
parentarray(Reference)Identifies a protocol or workflow that this MessageDefinition represents a step in.
replacesarray(Reference)A MessageDefinition that is superseded by this definition.
event*CodingA coded identifier of a supported messaging event.
categorystringThe impact of the content of the message.
focusarray(MessageDefinition_Focus)Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
responseRequiredbooleanIndicates whether a response is required for this message.
allowedResponsearray(MessageDefinition_AllowedResponse)Indicates what types of messages may be sent as an application-level response to this message.

Response

Patch Message Definition

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

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

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*stringMessageDefinitionThis is a MessageDefinition resource
urlstringAn absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the message definition.
statusstringdraft|active|retired|unknownThe status of this message definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this message 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 message 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 message definition changes.
publisherstringThe name of the individual or organization that published the message definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the message 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 message definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the message definition is intended to be used.
purposestringExplaination of why this message definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
baseReferenceThe MessageDefinition that is the basis for the contents of this resource.
parentarray(Reference)Identifies a protocol or workflow that this MessageDefinition represents a step in.
replacesarray(Reference)A MessageDefinition that is superseded by this definition.
event*CodingA coded identifier of a supported messaging event.
categorystringThe impact of the content of the message.
focusarray(MessageDefinition_Focus)Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
responseRequiredbooleanIndicates whether a response is required for this message.
allowedResponsearray(MessageDefinition_AllowedResponse)Indicates what types of messages may be sent as an application-level response to this message.

Response

Read Message Definition

get
/organizations/{organizationId}/fhir/3/MessageDefinition/{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 Message Definition

get
/organizations/{organizationId}/fhir/3/MessageDefinition/{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 Message Definition

get
/organizations/{organizationId}/fhir/3/MessageDefinition/{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 Message Definition

delete
/organizations/{organizationId}/fhir/3/MessageDefinition/{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 Message Definition

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

Request

Headers

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

Query params

_idstring
_languagestring
categorystring
datestring
descriptionstring
eventstring
focusstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Response

Search History Message Definition

get
/organizations/{organizationId}/fhir/3/MessageDefinition/_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 Message Definition

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

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Request

Headers

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

Query params

_idstring
_languagestring
categorystring
datestring
descriptionstring
eventstring
focusstring
identifierstring
jurisdictionstring
namestring
publisherstring
statusstring
titlestring
urlstring
versionstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMessageDefinitionThis is a MessageDefinition resource
urlstringAn absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the message definition.
statusstringdraft|active|retired|unknownThe status of this message definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this message 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 message 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 message definition changes.
publisherstringThe name of the individual or organization that published the message definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the message 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 message definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the message definition is intended to be used.
purposestringExplaination of why this message definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
baseReferenceThe MessageDefinition that is the basis for the contents of this resource.
parentarray(Reference)Identifies a protocol or workflow that this MessageDefinition represents a step in.
replacesarray(Reference)A MessageDefinition that is superseded by this definition.
event*CodingA coded identifier of a supported messaging event.
categorystringThe impact of the content of the message.
focusarray(MessageDefinition_Focus)Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
responseRequiredbooleanIndicates whether a response is required for this message.
allowedResponsearray(MessageDefinition_AllowedResponse)Indicates what types of messages may be sent as an application-level response to this message.

Response

Update Message Definition

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

Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMessageDefinitionThis is a MessageDefinition resource
urlstringAn absolute URI that is used to identify this message 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 message definition is (or will be) published. The URL SHOULD include the major version of the message definition. For more information see [Technical and Business Versions](resource.html#versions).
identifierIdentifierA formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
versionstringThe identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message 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 message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
titlestringA short, descriptive, user-friendly title for the message definition.
statusstringdraft|active|retired|unknownThe status of this message definition. Enables tracking the life-cycle of the content.
experimentalbooleanA boolean value to indicate that this message 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 message 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 message definition changes.
publisherstringThe name of the individual or organization that published the message definition.
contactarray(ContactDetail)Contact details to assist a user in finding and communicating with the publisher.
descriptionstringA free text natural language description of the message 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 message definition instances.
jurisdictionarray(CodeableConcept)A legal or geographic region in which the message definition is intended to be used.
purposestringExplaination of why this message definition is needed and why it has been designed as it has.
copyrightstringA copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
baseReferenceThe MessageDefinition that is the basis for the contents of this resource.
parentarray(Reference)Identifies a protocol or workflow that this MessageDefinition represents a step in.
replacesarray(Reference)A MessageDefinition that is superseded by this definition.
event*CodingA coded identifier of a supported messaging event.
categorystringThe impact of the content of the message.
focusarray(MessageDefinition_Focus)Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
responseRequiredbooleanIndicates whether a response is required for this message.
allowedResponsearray(MessageDefinition_AllowedResponse)Indicates what types of messages may be sent as an application-level response to this message.

Response