schemas.MessageDefinition.schema.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fhirlib Show documentation
Show all versions of fhirlib Show documentation
A scala ser/de library for working with FHIR data
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://hl7.org/fhir/json-schema/MessageDefinition",
"$ref": "#/definitions/MessageDefinition",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"MessageDefinition": {
"allOf": [
{
"$ref": "DomainResource#/definitions/DomainResource"
},
{
"description": "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.",
"properties": {
"resourceType": {
"description": "This is a MessageDefinition resource",
"type": "string",
"enum": [
"MessageDefinition"
]
},
"url": {
"description": "An 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).",
"type": "string"
},
"_url": {
"description": "Extensions for url",
"$ref": "Element.schema.json#/definitions/Element"
},
"identifier": {
"description": "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.",
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"version": {
"description": "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.",
"type": "string"
},
"_version": {
"description": "Extensions for version",
"$ref": "Element.schema.json#/definitions/Element"
},
"name": {
"description": "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.",
"type": "string"
},
"_name": {
"description": "Extensions for name",
"$ref": "Element.schema.json#/definitions/Element"
},
"title": {
"description": "A short, descriptive, user-friendly title for the message definition.",
"type": "string"
},
"_title": {
"description": "Extensions for title",
"$ref": "Element.schema.json#/definitions/Element"
},
"status": {
"description": "The status of this message definition. Enables tracking the life-cycle of the content.",
"enum": [
"draft",
"active",
"retired",
"unknown"
],
"type": "string"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"experimental": {
"description": "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.",
"type": "boolean"
},
"_experimental": {
"description": "Extensions for experimental",
"$ref": "Element.schema.json#/definitions/Element"
},
"date": {
"description": "The 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.",
"type": "string",
"pattern": "-?[0-9]{4}(-(0[1-9]|1[0-2])(-(0[0-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"publisher": {
"description": "The name of the individual or organization that published the message definition.",
"type": "string"
},
"_publisher": {
"description": "Extensions for publisher",
"$ref": "Element.schema.json#/definitions/Element"
},
"contact": {
"description": "Contact details to assist a user in finding and communicating with the publisher.",
"type": "array",
"items": {
"$ref": "ContactDetail.schema.json#/definitions/ContactDetail"
}
},
"description": {
"description": "A free text natural language description of the message definition from a consumer\u0027s perspective.",
"type": "string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"useContext": {
"description": "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.",
"type": "array",
"items": {
"$ref": "UsageContext.schema.json#/definitions/UsageContext"
}
},
"jurisdiction": {
"description": "A legal or geographic region in which the message definition is intended to be used.",
"type": "array",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
}
},
"purpose": {
"description": "Explaination of why this message definition is needed and why it has been designed as it has.",
"type": "string"
},
"_purpose": {
"description": "Extensions for purpose",
"$ref": "Element.schema.json#/definitions/Element"
},
"copyright": {
"description": "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.",
"type": "string"
},
"_copyright": {
"description": "Extensions for copyright",
"$ref": "Element.schema.json#/definitions/Element"
},
"base": {
"description": "The MessageDefinition that is the basis for the contents of this resource.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"parent": {
"description": "Identifies a protocol or workflow that this MessageDefinition represents a step in.",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"replaces": {
"description": "A MessageDefinition that is superseded by this definition.",
"type": "array",
"items": {
"$ref": "Reference.schema.json#/definitions/Reference"
}
},
"event": {
"description": "A coded identifier of a supported messaging event.",
"$ref": "Coding.schema.json#/definitions/Coding"
},
"category": {
"description": "The impact of the content of the message.",
"type": "string",
"pattern": "[^\\s]+([\\s]?[^\\s]+)*"
},
"_category": {
"description": "Extensions for category",
"$ref": "Element.schema.json#/definitions/Element"
},
"focus": {
"description": "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.",
"type": "array",
"items": {
"$ref": "#/definitions/MessageDefinition_Focus"
}
},
"responseRequired": {
"description": "Indicates whether a response is required for this message.",
"type": "boolean"
},
"_responseRequired": {
"description": "Extensions for responseRequired",
"$ref": "Element.schema.json#/definitions/Element"
},
"allowedResponse": {
"description": "Indicates what types of messages may be sent as an application-level response to this message.",
"type": "array",
"items": {
"$ref": "#/definitions/MessageDefinition_AllowedResponse"
}
}
},
"required": [
"event",
"resourceType"
]
}
]
},
"MessageDefinition_Focus": {
"allOf": [
{
"$ref": "BackboneElement#/definitions/BackboneElement"
},
{
"description": "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.",
"properties": {
"code": {
"description": "The kind of resource that must be the focus for this message.",
"type": "string",
"pattern": "[^\\s]+([\\s]?[^\\s]+)*"
},
"_code": {
"description": "Extensions for code",
"$ref": "Element.schema.json#/definitions/Element"
},
"profile": {
"description": "A profile that reflects constraints for the focal resource (and potentially for related resources).",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"min": {
"description": "Identifies the minimum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.",
"type": "number",
"pattern": "[0]|([1-9][0-9]*)"
},
"_min": {
"description": "Extensions for min",
"$ref": "Element.schema.json#/definitions/Element"
},
"max": {
"description": "Identifies the maximum number of resources of this type that must be pointed to by a message in order for it to be valid against this MessageDefinition.",
"type": "string"
},
"_max": {
"description": "Extensions for max",
"$ref": "Element.schema.json#/definitions/Element"
}
}
}
]
},
"MessageDefinition_AllowedResponse": {
"allOf": [
{
"$ref": "BackboneElement#/definitions/BackboneElement"
},
{
"description": "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.",
"properties": {
"message": {
"description": "A reference to the message definition that must be adhered to by this supported response.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"situation": {
"description": "Provides a description of the circumstances in which this response should be used (as opposed to one of the alternative responses).",
"type": "string"
},
"_situation": {
"description": "Extensions for situation",
"$ref": "Element.schema.json#/definitions/Element"
}
},
"required": [
"message"
]
}
]
}
}
}