# Update FHIR r4 event definition
Endpoint: PUT /site/{siteId}/fhir/event-definition/{id}
Version: 1.0
Security: bearer, bearer
## Path parameters:
- `siteId` (string, required)
Site identifier
- `id` (string, required)
ID of the EventDefinition to update
## Request fields (application/json):
- `resourceType` (any, required)
This is a EventDefinition resource
Enum: "EventDefinition"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. 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.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "
Example
"
- `contained` (array)
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.
- `extension` (array)
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.
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
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).
- `url` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_url` (object)
Base definition for all elements in a resource.
- `identifier` (array)
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `version` (string)
A sequence of Unicode characters
Example: "example-string"
- `_version` (object)
Base definition for all elements in a resource.
- `name` (string)
A sequence of Unicode characters
Example: "example-string"
- `_name` (object)
Base definition for all elements in a resource.
- `title` (string)
A sequence of Unicode characters
Example: "example-string"
- `_title` (object)
Base definition for all elements in a resource.
- `subtitle` (string)
A sequence of Unicode characters
Example: "example-string"
- `_subtitle` (object)
Base definition for all elements in a resource.
- `status` (any)
The status of this event definition. Enables tracking the life-cycle of the content.
Enum: "draft", "active", "retired", "unknown"
- `_status` (object)
Base definition for all elements in a resource.
- `experimental` (boolean)
Value of "true" or "false"
Example: true
- `_experimental` (object)
Base definition for all elements in a resource.
- `subjectCodeableConcept` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `subjectCodeableConcept.coding` (array)
A reference to a code defined by a terminology system.
- `subjectCodeableConcept.text` (string)
An extension object type #string.
Example: "example-string"
- `subjectCodeableConcept._text` (object)
An extension object type #Element.
- `subjectReference` (object)
A reference from one resource to another.
- `subjectReference.reference` (string)
An extension object type #string.
Example: "example-string"
- `subjectReference._reference` (object)
An extension object type #Element.
- `subjectReference.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `subjectReference._type` (object)
An extension object type #Element.
- `subjectReference.identifier` (object)
An extension object type #Identifier.
- `subjectReference.display` (string)
An extension object type #string.
Example: "example-string"
- `subjectReference._display` (object)
An extension object type #Element.
- `date` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_date` (object)
Base definition for all elements in a resource.
- `publisher` (string)
A sequence of Unicode characters
Example: "example-string"
- `_publisher` (object)
Base definition for all elements in a resource.
- `contact` (array)
Contact details to assist a user in finding and communicating with the publisher.
- `contact.name` (string)
An extension object type #string.
Example: "example-string"
- `contact._name` (object)
An extension object type #Element.
- `contact.telecom` (array)
The contact details for the individual (if a name was provided) or the organization.
- `description` (string)
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Example: "Sample markdown text"
- `_description` (object)
Base definition for all elements in a resource.
- `useContext` (array)
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 event definition instances.
- `useContext.code` (object, required)
An extension object type #Coding.
- `jurisdiction` (array)
A legal or geographic region in which the event definition is intended to be used.
- `purpose` (string)
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Example: "Sample markdown text"
- `_purpose` (object)
Base definition for all elements in a resource.
- `usage` (string)
A sequence of Unicode characters
Example: "example-string"
- `_usage` (object)
Base definition for all elements in a resource.
- `copyright` (string)
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Example: "Sample markdown text"
- `_copyright` (object)
Base definition for all elements in a resource.
- `approvalDate` (string)
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
Example: "2024-01-01"
- `_approvalDate` (object)
Base definition for all elements in a resource.
- `lastReviewDate` (string)
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
Example: "2024-01-01"
- `_lastReviewDate` (object)
Base definition for all elements in a resource.
- `effectivePeriod` (object)
A time period defined by a start and end date and optionally time.
- `effectivePeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `effectivePeriod._start` (object)
An extension object type #Element.
- `effectivePeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `effectivePeriod._end` (object)
An extension object type #Element.
- `topic` (array)
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
- `author` (array)
An individiual or organization primarily involved in the creation and maintenance of the content.
- `editor` (array)
An individual or organization primarily responsible for internal coherence of the content.
- `reviewer` (array)
An individual or organization primarily responsible for review of some aspect of the content.
- `endorser` (array)
An individual or organization responsible for officially endorsing the content for use in some setting.
- `relatedArtifact` (array)
Related resources such as additional documentation, justification, or bibliographic references.
- `relatedArtifact.type` (any)
The type of relationship to the related artifact.
Enum: "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of"
- `relatedArtifact.label` (string)
An extension object type #string.
Example: "example-string"
- `relatedArtifact._label` (object)
An extension object type #Element.
- `relatedArtifact.citation` (object)
An extension object type #markdown.
- `relatedArtifact._citation` (object)
An extension object type #Element.
- `relatedArtifact.url` (string)
An extension object type #url.
Example: "https://example.org"
- `relatedArtifact.document` (object)
An extension object type #Attachment.
- `relatedArtifact.resource` (string)
An extension object type #canonical.
Example: "http://example.org/Profile"
- `trigger` (array, required)
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
Example: [{"type":"named-event","name":"monitor-emergency-admissions","data":[{"type":"Encounter"}],"condition":{"description":"Encounter Location = emergency (active/completed encounters, current or previous)","language":"text/fhirpath","expression":"(this | %previous).location.where(location = \"Location/emergency\" and status in {\"active\", \"completed\"}).exists()"}}]
- `trigger.type` (any)
The type of triggering event.
Enum: "named-event", "periodic", "data-changed", "data-added", "data-modified", "data-removed", "data-accessed", "data-access-ended"
- `trigger.timingTiming` (object)
An extension object type #Timing.
- `trigger.timingReference` (object)
An extension object type #Reference.
- `trigger.timingDate` (string)
The timing of the event (if this is a periodic trigger).
Example: "2024-01-01"
- `trigger._timingDate` (object)
An extension object type #Element.
- `trigger.timingDateTime` (string)
The timing of the event (if this is a periodic trigger).
Example: "2024-01-01T00:00:00Z"
- `trigger._timingDateTime` (object)
An extension object type #Element.
- `trigger.data` (array)
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
- `trigger.condition` (object)
An extension object type #Expression.
## Response 200 fields (application/json):
- `resourceType` (any, required)
This is a EventDefinition resource
Enum: "EventDefinition"
- `id` (string)
Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.
Example: "example-id"
- `meta` (object)
The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
- `meta.id` (string)
An extension object type #string.
Example: "example-string"
- `meta.extension` (array)
May be used to represent additional information that is not part of the basic definition of the element. 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.
- `meta.versionId` (object)
An extension object type #id.
- `meta._versionId` (object)
An extension object type #Element.
- `meta.lastUpdated` (object)
An extension object type #instant.
- `meta._lastUpdated` (object)
An extension object type #Element.
- `meta.source` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `meta._source` (object)
An extension object type #Element.
- `meta.profile` (array)
A list of profiles (references to [[[StructureDefinition]]] resources) that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].
Example: ["http://example.org/Profile"]
- `meta.security` (array)
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
- `meta.tag` (array)
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
- `implicitRules` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_implicitRules` (object)
Base definition for all elements in a resource.
- `language` (string)
A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents
Example: "sample-code"
- `_language` (object)
Base definition for all elements in a resource.
- `text` (object)
A human-readable summary of the resource conveying the essential clinical and business information for the resource.
- `text.status` (any)
The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.
Enum: "generated", "extensions", "additional", "empty"
- `text._status` (object)
An extension object type #Element.
- `text.div` (string, required)
An extension object type #xhtml.
Example: "Example
"
- `contained` (array)
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.
- `extension` (array)
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.
- `extension.url` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `extension._url` (object)
An extension object type #Element.
- `extension.valueBase64Binary` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "U2FtcGxl"
- `extension._valueBase64Binary` (object)
An extension object type #Element.
- `extension.valueBoolean` (boolean)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: true
- `extension._valueBoolean` (object)
An extension object type #Element.
- `extension.valueCanonical` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "http://example.org/Profile"
- `extension._valueCanonical` (object)
An extension object type #Element.
- `extension.valueCode` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "sample-code"
- `extension._valueCode` (object)
An extension object type #Element.
- `extension.valueDate` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01"
- `extension._valueDate` (object)
An extension object type #Element.
- `extension.valueDateTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueDateTime` (object)
An extension object type #Element.
- `extension.valueDecimal` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1.23
- `extension._valueDecimal` (object)
An extension object type #Element.
- `extension.valueId` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-id"
- `extension._valueId` (object)
An extension object type #Element.
- `extension.valueInstant` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "2024-01-01T00:00:00Z"
- `extension._valueInstant` (object)
An extension object type #Element.
- `extension.valueInteger` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valueInteger` (object)
An extension object type #Element.
- `extension.valueMarkdown` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "Sample markdown text"
- `extension._valueMarkdown` (object)
An extension object type #Element.
- `extension.valueOid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:oid:1.2.3.4.5"
- `extension._valueOid` (object)
An extension object type #Element.
- `extension.valuePositiveInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: 1
- `extension._valuePositiveInt` (object)
An extension object type #Element.
- `extension.valueString` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "example-string"
- `extension._valueString` (object)
An extension object type #Element.
- `extension.valueTime` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "12:00:00"
- `extension._valueTime` (object)
An extension object type #Element.
- `extension.valueUnsignedInt` (number)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
- `extension._valueUnsignedInt` (object)
An extension object type #Element.
- `extension.valueUri` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org/resource"
- `extension._valueUri` (object)
An extension object type #Element.
- `extension.valueUrl` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "https://example.org"
- `extension._valueUrl` (object)
An extension object type #Element.
- `extension.valueUuid` (string)
Value of extension - must be one of a constrained set of the data types (see [Extensibility](https://hl7.org/fhir/extensibility.html) for a list).
Example: "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
- `extension._valueUuid` (object)
An extension object type #Element.
- `extension.valueAddress` (object)
An extension object type #Address.
- `extension.valueAge` (object)
An extension object type #Age.
- `extension.valueAnnotation` (object)
An extension object type #Annotation.
- `extension.valueAttachment` (object)
An extension object type #Attachment.
- `extension.valueCodeableConcept` (object)
An extension object type #CodeableConcept.
- `extension.valueCoding` (object)
An extension object type #Coding.
- `extension.valueContactPoint` (object)
An extension object type #ContactPoint.
- `extension.valueCount` (object)
An extension object type #Count.
- `extension.valueDistance` (object)
An extension object type #Distance.
- `extension.valueDuration` (object)
An extension object type #Duration.
- `extension.valueHumanName` (object)
An extension object type #HumanName.
- `extension.valueIdentifier` (object)
An extension object type #Identifier.
- `extension.valueMoney` (object)
An extension object type #Money.
- `extension.valuePeriod` (object)
An extension object type #Period.
- `extension.valueQuantity` (object)
An extension object type #Quantity.
- `extension.valueRange` (object)
An extension object type #Range.
- `extension.valueRatio` (object)
An extension object type #Ratio.
- `extension.valueReference` (object)
An extension object type #Reference.
- `extension.valueSampledData` (object)
An extension object type #SampledData.
- `extension.valueSignature` (object)
An extension object type #Signature.
- `extension.valueTiming` (object)
An extension object type #Timing.
- `extension.valueContactDetail` (object)
An extension object type #ContactDetail.
- `extension.valueContributor` (object)
An extension object type #Contributor.
- `extension.valueDataRequirement` (object)
An extension object type #DataRequirement.
- `extension.valueExpression` (object)
An extension object type #Expression.
- `extension.valueParameterDefinition` (object)
An extension object type #ParameterDefinition.
- `extension.valueRelatedArtifact` (object)
An extension object type #RelatedArtifact.
- `extension.valueTriggerDefinition` (object)
An extension object type #TriggerDefinition.
- `extension.valueUsageContext` (object)
An extension object type #UsageContext.
- `extension.valueDosage` (object)
An extension object type #Dosage.
- `extension.valueMeta` (object)
An extension object type #Meta.
- `modifierExtension` (array)
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).
- `url` (string)
String of characters used to identify a name or a resource
Example: "https://example.org/resource"
- `_url` (object)
Base definition for all elements in a resource.
- `identifier` (array)
A formal identifier that is used to identify this event definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
- `identifier.use` (any)
The purpose of this identifier.
Enum: "usual", "official", "temp", "secondary", "old"
- `identifier._use` (object)
An extension object type #Element.
- `identifier.type` (object)
An extension object type #CodeableConcept.
- `identifier.system` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `identifier._system` (object)
An extension object type #Element.
- `identifier.value` (string)
An extension object type #string.
Example: "example-string"
- `identifier._value` (object)
An extension object type #Element.
- `identifier.period` (object)
An extension object type #Period.
- `identifier.assigner` (object)
An extension object type #Reference.
- `version` (string)
A sequence of Unicode characters
Example: "example-string"
- `_version` (object)
Base definition for all elements in a resource.
- `name` (string)
A sequence of Unicode characters
Example: "example-string"
- `_name` (object)
Base definition for all elements in a resource.
- `title` (string)
A sequence of Unicode characters
Example: "example-string"
- `_title` (object)
Base definition for all elements in a resource.
- `subtitle` (string)
A sequence of Unicode characters
Example: "example-string"
- `_subtitle` (object)
Base definition for all elements in a resource.
- `status` (any)
The status of this event definition. Enables tracking the life-cycle of the content.
Enum: "draft", "active", "retired", "unknown"
- `_status` (object)
Base definition for all elements in a resource.
- `experimental` (boolean)
Value of "true" or "false"
Example: true
- `_experimental` (object)
Base definition for all elements in a resource.
- `subjectCodeableConcept` (object)
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.
- `subjectCodeableConcept.coding` (array)
A reference to a code defined by a terminology system.
- `subjectCodeableConcept.text` (string)
An extension object type #string.
Example: "example-string"
- `subjectCodeableConcept._text` (object)
An extension object type #Element.
- `subjectReference` (object)
A reference from one resource to another.
- `subjectReference.reference` (string)
An extension object type #string.
Example: "example-string"
- `subjectReference._reference` (object)
An extension object type #Element.
- `subjectReference.type` (string)
An extension object type #uri.
Example: "https://example.org/resource"
- `subjectReference._type` (object)
An extension object type #Element.
- `subjectReference.identifier` (object)
An extension object type #Identifier.
- `subjectReference.display` (string)
An extension object type #string.
Example: "example-string"
- `subjectReference._display` (object)
An extension object type #Element.
- `date` (string)
A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.
Example: "2024-01-01T00:00:00Z"
- `_date` (object)
Base definition for all elements in a resource.
- `publisher` (string)
A sequence of Unicode characters
Example: "example-string"
- `_publisher` (object)
Base definition for all elements in a resource.
- `contact` (array)
Contact details to assist a user in finding and communicating with the publisher.
- `contact.name` (string)
An extension object type #string.
Example: "example-string"
- `contact._name` (object)
An extension object type #Element.
- `contact.telecom` (array)
The contact details for the individual (if a name was provided) or the organization.
- `description` (string)
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Example: "Sample markdown text"
- `_description` (object)
Base definition for all elements in a resource.
- `useContext` (array)
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 event definition instances.
- `useContext.code` (object, required)
An extension object type #Coding.
- `jurisdiction` (array)
A legal or geographic region in which the event definition is intended to be used.
- `purpose` (string)
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Example: "Sample markdown text"
- `_purpose` (object)
Base definition for all elements in a resource.
- `usage` (string)
A sequence of Unicode characters
Example: "example-string"
- `_usage` (object)
Base definition for all elements in a resource.
- `copyright` (string)
A string that may contain Github Flavored Markdown syntax for optional processing by a mark down presentation engine
Example: "Sample markdown text"
- `_copyright` (object)
Base definition for all elements in a resource.
- `approvalDate` (string)
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
Example: "2024-01-01"
- `_approvalDate` (object)
Base definition for all elements in a resource.
- `lastReviewDate` (string)
A date or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates.
Example: "2024-01-01"
- `_lastReviewDate` (object)
Base definition for all elements in a resource.
- `effectivePeriod` (object)
A time period defined by a start and end date and optionally time.
- `effectivePeriod.start` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `effectivePeriod._start` (object)
An extension object type #Element.
- `effectivePeriod.end` (string)
An extension object type #dateTime.
Example: "2024-01-01T00:00:00Z"
- `effectivePeriod._end` (object)
An extension object type #Element.
- `topic` (array)
Descriptive topics related to the module. Topics provide a high-level categorization of the module that can be useful for filtering and searching.
- `author` (array)
An individiual or organization primarily involved in the creation and maintenance of the content.
- `editor` (array)
An individual or organization primarily responsible for internal coherence of the content.
- `reviewer` (array)
An individual or organization primarily responsible for review of some aspect of the content.
- `endorser` (array)
An individual or organization responsible for officially endorsing the content for use in some setting.
- `relatedArtifact` (array)
Related resources such as additional documentation, justification, or bibliographic references.
- `relatedArtifact.type` (any)
The type of relationship to the related artifact.
Enum: "documentation", "justification", "citation", "predecessor", "successor", "derived-from", "depends-on", "composed-of"
- `relatedArtifact.label` (string)
An extension object type #string.
Example: "example-string"
- `relatedArtifact._label` (object)
An extension object type #Element.
- `relatedArtifact.citation` (object)
An extension object type #markdown.
- `relatedArtifact._citation` (object)
An extension object type #Element.
- `relatedArtifact.url` (string)
An extension object type #url.
Example: "https://example.org"
- `relatedArtifact.document` (object)
An extension object type #Attachment.
- `relatedArtifact.resource` (string)
An extension object type #canonical.
Example: "http://example.org/Profile"
- `trigger` (array, required)
The trigger element defines when the event occurs. If more than one trigger condition is specified, the event fires whenever any one of the trigger conditions is met.
Example: [{"type":"named-event","name":"monitor-emergency-admissions","data":[{"type":"Encounter"}],"condition":{"description":"Encounter Location = emergency (active/completed encounters, current or previous)","language":"text/fhirpath","expression":"(this | %previous).location.where(location = \"Location/emergency\" and status in {\"active\", \"completed\"}).exists()"}}]
- `trigger.type` (any)
The type of triggering event.
Enum: "named-event", "periodic", "data-changed", "data-added", "data-modified", "data-removed", "data-accessed", "data-access-ended"
- `trigger.timingTiming` (object)
An extension object type #Timing.
- `trigger.timingReference` (object)
An extension object type #Reference.
- `trigger.timingDate` (string)
The timing of the event (if this is a periodic trigger).
Example: "2024-01-01"
- `trigger._timingDate` (object)
An extension object type #Element.
- `trigger.timingDateTime` (string)
The timing of the event (if this is a periodic trigger).
Example: "2024-01-01T00:00:00Z"
- `trigger._timingDateTime` (object)
An extension object type #Element.
- `trigger.data` (array)
The triggering data of the event (if this is a data trigger). If more than one data is requirement is specified, then all the data requirements must be true.
- `trigger.condition` (object)
An extension object type #Expression.
## Response 401 fields (application/json):
- `message` (string, required)
Error message indicating unauthorized access.
Example: "Unauthorized"
- `statusCode` (number, required)
HTTP status code for unauthorized access.
Example: 401
## Response 400 fields
## Response 404 fields