Skip to main content

MessageDefinitionCreateInput

No description

input MessageDefinitionCreateInput {
  url: Uri
  identifier: [IdentifierCreateInput!]
  version: String
  name: String
  title: String
  replaces: [Uri!]
  status: String!
  experimental: Boolean
  date: Date!
  publisher: String
  contact: [ContactDetailCreateInput!]
  description: String
  useContext: [UsageContextCreateInput!]
  jurisdiction: [CodeableConceptCreateInput!]
  purpose: String
  copyright: String
  base: Uri
  parent: [Uri!]
  eventCoding: CodingCreateInput
  eventUri: Uri
  category: String
  focus: [MessageDefinitionFocusCreateInput!]
  responseRequired: String
  allowedResponse: [MessageDefinitionAllowedResponseCreateInput!]
  graph: [Uri!]
  text: NarrativeCreateInput
  contained: [ResourceCreateInput!]
  extension: [FhirExtensionCreateInput!]
  modifierExtension: [FhirExtensionCreateInput!]
  id: String
  meta: FhirMetaCreateInput
  implicitRules: Uri
  language: String
}

Fields​

MessageDefinitionCreateInput.url ● Uri scalar​

The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.

MessageDefinitionCreateInput.identifier ● [IdentifierCreateInput!] list input​

A 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.

MessageDefinitionCreateInput.version ● String scalar​

The 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.

MessageDefinitionCreateInput.name ● String scalar​

A 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.

MessageDefinitionCreateInput.title ● String scalar​

A short, descriptive, user-friendly title for the message definition.

MessageDefinitionCreateInput.replaces ● [Uri!] list scalar​

A MessageDefinition that is superseded by this definition.

MessageDefinitionCreateInput.status ● String! non-null scalar​

The status of this message definition. Enables tracking the life-cycle of the content.

MessageDefinitionCreateInput.experimental ● Boolean scalar​

A 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.

MessageDefinitionCreateInput.date ● Date! non-null scalar​

The date (and optionally time) when the message definition was published. The date must change 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.

MessageDefinitionCreateInput.publisher ● String scalar​

The name of the organization or individual that published the message definition.

MessageDefinitionCreateInput.contact ● [ContactDetailCreateInput!] list input​

Contact details to assist a user in finding and communicating with the publisher.

MessageDefinitionCreateInput.description ● String scalar​

A free text natural language description of the message definition from a consumer s perspective.

MessageDefinitionCreateInput.useContext ● [UsageContextCreateInput!] list input​

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.

MessageDefinitionCreateInput.jurisdiction ● [CodeableConceptCreateInput!] list input​

A legal or geographic region in which the message definition is intended to be used.

MessageDefinitionCreateInput.purpose ● String scalar​

Explanation of why this message definition is needed and why it has been designed as it has.

MessageDefinitionCreateInput.copyright ● String scalar​

A 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.

MessageDefinitionCreateInput.base ● Uri scalar​

The MessageDefinition that is the basis for the contents of this resource.

MessageDefinitionCreateInput.parent ● [Uri!] list scalar​

Identifies a protocol or workflow that this MessageDefinition represents a step in.

MessageDefinitionCreateInput.eventCoding ● CodingCreateInput input​

Event code or link to the EventDefinition. (choose any one of event*, but only one)

MessageDefinitionCreateInput.eventUri ● Uri scalar​

Event code or link to the EventDefinition. (choose any one of event*, but only one)

MessageDefinitionCreateInput.category ● String scalar​

The impact of the content of the message.

MessageDefinitionCreateInput.focus ● [MessageDefinitionFocusCreateInput!] list input​

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.

MessageDefinitionCreateInput.responseRequired ● String scalar​

Declare at a message definition level whether a response is required or only upon error or success, or never.

MessageDefinitionCreateInput.allowedResponse ● [MessageDefinitionAllowedResponseCreateInput!] list input​

Indicates what types of messages may be sent as an application-level response to this message.

MessageDefinitionCreateInput.graph ● [Uri!] list scalar​

Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.

MessageDefinitionCreateInput.text ● NarrativeCreateInput input​

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

MessageDefinitionCreateInput.contained ● [ResourceCreateInput!] list input​

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

MessageDefinitionCreateInput.extension ● [FhirExtensionCreateInput!] list input​

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

MessageDefinitionCreateInput.modifierExtension ● [FhirExtensionCreateInput!] list input​

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

MessageDefinitionCreateInput.id ● String scalar​

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

MessageDefinitionCreateInput.meta ● FhirMetaCreateInput input​

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

MessageDefinitionCreateInput.implicitRules ● Uri scalar​

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

MessageDefinitionCreateInput.language ● String scalar​

The base language in which the resource is written.

Member Of​

MessageDefinitionCreate mutation