rtlsSubscription
type: StructureDefinition
node role: treeRoot
id:
  v: rtlsSubscription
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> Subscription 0..* Subscription Notification about a SubscriptionTopic identifier S 1..* Identifier Additional identifiers (business identifier) status S 1..1 code requested | active | error | off | entered-in-error topic S 1..1 canonical(RTLS Subscription Topic Profile) Reference to the RTLS subscription topic being subscribed to (e.g. location updates) channelType S 1..1 Coding Set to "message" endpoint S 0..1 url Where the channel points to <img src="[binary]" alt="doco" style="background-color: inherit"/> Documentation for this format
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status
  value:
    v: informative
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom
      value:
        v: http://hl7.org/fhir/uv/rtls/ImplementationGuide/hl7.fhir.uv.rtls
        link: http://hl7.org/fhir/uv/rtls/ImplementationGuide/hl7.fhir.uv.rtls
url:
  v: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscription
version:
  v: 1.0.0-ballot
name:
  v: RTLSSubscription
title:
  v: RTLS Subscription
status:
  v: draft
experimental:
  v: true
date:
  v: 2023-05-10T16:46:10+00:00
publisher:
  v: HL7 International - Patient Administration Work Group
contact:
  telecom:
    system:
      v: url
    value:
      v: http://hl7.org/Special/committees/pafm
description:
  v: Subscription resource used in RTLS workflows.
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
    code:
      v: 001
purpose:
  v: This profile defines minimum expectations for a subscription requested from a RTLS.
fhir version:
  v: 5.0.0
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: Subscription
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Subscription
  link: http://hl7.org/fhir/StructureDefinition/Subscription
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: Subscription
    path:
      v: Subscription
    short:
      v: Notification about a SubscriptionTopic
    definition:
      v: The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
    alias:
      v: WebHook
    alias:
      v: Hook
    alias:
      v: Routing Rule
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Subscription
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
      expression:
        v: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    must support:
      v: false
    is modifier:
      v: false
    is summary:
      v: false
    mapping:
      identity:
        v: rim
      map:
        v: Entity, Role, or Act,N/A
    mapping:
      identity:
        v: w5
      map:
        v: infrastructure.exchange
  element:
    id:
      v: Subscription.id
    path:
      v: Subscription.id
    short:
      v: Logical id of this artifact
    definition:
      v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
    comment:
      v: Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
    min:
      v: 0
    max:
      v: 1
    base:
      path:
        v: Resource.id
      min:
        v: 0
      max:
        v: 1

v: true

v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
  value:
    v: id
code:
  v: http://hl7.org/fhirpath/System.String

v: false

v: false

v: true

id:
  v: Subscription.meta
path:
  v: Subscription.meta
short:
  v: Metadata about the resource
definition:
  v: 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.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.implicitRules
path:
  v: Subscription.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: 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.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
is summary:
  v: true

id:
  v: Subscription.language
path:
  v: Subscription.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: required
  description:
    v: IETF language tag for a human language
  value set:
    v: http://hl7.org/fhir/ValueSet/all-languages|5.0.0
    link: 5.0
    link: .0
  additional:
    purpose:
      v: starter
    value set:
      v: http://hl7.org/fhir/ValueSet/languages
      link: http://hl7.org/fhir/ValueSet/languages

id:
  v: Subscription.text
path:
  v: Subscription.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: 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.
comment:
  v: Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
condition:
  v: dom-6
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Subscription.contained
path:
  v: Subscription.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
condition:
  v: dom-2
condition:
  v: dom-4
condition:
  v: dom-3
condition:
  v: dom-5
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Subscription.extension
path:
  v: Subscription.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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 managable, 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.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Subscription.modifierExtension
path:
  v: Subscription.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: 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 managable, 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).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: false
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Subscription.identifier
path:
  v: Subscription.identifier
short:
  v: Additional identifiers (business identifier)
definition:
  v: A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
min:
  v: 1
max:
  v: *
base:
  path:
    v: Subscription.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier

id:
  v: Subscription.name
path:
  v: Subscription.name
short:
  v: Human readable name for this subscription
definition:
  v: A natural language name identifying the subscription.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.status
path:
  v: Subscription.status
short:
  v: requested | active | error | off | entered-in-error
definition:
  v: The status of the subscription, which marks the server state for managing the subscription.
comment:
  v: A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.status
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SubscriptionStatusCodes
  strength:
    v: required
  description:
    v: The status of a subscription.
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-status|5.0.0
    link: 5.0
    link: .0
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status

id:
  v: Subscription.topic
path:
  v: Subscription.topic
short:
  v: Reference to the RTLS subscription topic being subscribed to (e.g. location updates)
definition:
  v: The reference to the subscription topic to be notified about.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.topic
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: canonical
  target profile:
    v: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic
    link: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.what[x]

id:
  v: Subscription.contact
path:
  v: Subscription.contact
short:
  v: Contact details for source (e.g. troubleshooting)
definition:
  v: Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Subscription.contact
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.subject[x]

id:
  v: Subscription.end
path:
  v: Subscription.end
short:
  v: When to automatically delete the subscription
definition:
  v: The time for the server to turn the subscription off.
comment:
  v: The server is permitted to deviate from this time but should observe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.end
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: instant
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.done[x]

id:
  v: Subscription.managingEntity
path:
  v: Subscription.managingEntity
short:
  v: Entity responsible for Subscription changes
definition:
  v: Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.managingEntity
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/CareTeam
    link: http://hl7.org/fhir/StructureDefinition/CareTeam
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/HealthcareService
    link: http://hl7.org/fhir/StructureDefinition/HealthcareService
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/RelatedPerson
    link: http://hl7.org/fhir/StructureDefinition/RelatedPerson
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Patient
    link: http://hl7.org/fhir/StructureDefinition/Patient
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Practitioner
    link: http://hl7.org/fhir/StructureDefinition/Practitioner
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/PractitionerRole
    link: http://hl7.org/fhir/StructureDefinition/PractitionerRole
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.author

id:
  v: Subscription.reason
path:
  v: Subscription.reason
short:
  v: Description of why this subscription was created
definition:
  v: A description of why this subscription is defined.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.reason
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.why[x]

id:
  v: Subscription.filterBy
path:
  v: Subscription.filterBy
short:
  v: Criteria for narrowing the subscription topic stream
definition:
  v: The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).
min:
  v: 0
max:
  v: *
base:
  path:
    v: Subscription.filterBy
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: scr-1
  severity:
    v: error
  human:
    v: Subscription filters may only contain a modifier or a comparator
  expression:
    v: (comparator.exists() and modifier.exists()).not()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Subscription
    link: http://hl7.org/fhir/StructureDefinition/Subscription
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.filterBy.id
path:
  v: Subscription.filterBy.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Subscription.filterBy.extension
path:
  v: Subscription.filterBy.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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 managable, 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.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Subscription.filterBy.modifierExtension
path:
  v: Subscription.filterBy.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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. 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).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Subscription.filterBy.resourceType
path:
  v: Subscription.filterBy.resourceType
short:
  v: Allowed Resource (reference to definition) for this Subscription filter
definition:
  v: A resource listed in the `SubscriptionTopic` this `Subscription` references (`SubscriptionTopic.canFilterBy.resource`). This element can be used to differentiate filters for topics that include more than one resource type.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.filterBy.resourceType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: FHIRTypes
  strength:
    v: extensible
  description:
    v: A type of resource, or a Reference (from all versions)
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-types
    link: http://hl7.org/fhir/ValueSet/subscription-types
  additional:
    purpose:
      v: ui
    value set:
      v: http://hl7.org/fhir/ValueSet/all-resource-types
      link: http://hl7.org/fhir/ValueSet/all-resource-types

id:
  v: Subscription.filterBy.filterParameter
path:
  v: Subscription.filterBy.filterParameter
short:
  v: Filter label defined in SubscriptionTopic
definition:
  v: The filter as defined in the `SubscriptionTopic.canFilterBy.filterParameter` element.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.filterBy.filterParameter
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.filterBy.comparator
path:
  v: Subscription.filterBy.comparator
short:
  v: eq | ne | gt | lt | ge | le | sa | eb | ap
definition:
  v: Comparator applied to this filter parameter.
comment:
  v: Must be a comparator allowed by the SubscriptionTopic relevant to this Subscription filter.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.filterBy.comparator
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: scr-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SearchComparator
  strength:
    v: required
  description:
    v: Search Comparator Codes applied to this filter.
  value set:
    v: http://hl7.org/fhir/ValueSet/search-comparator|5.0.0
    link: 5.0
    link: .0

id:
  v: Subscription.filterBy.modifier
path:
  v: Subscription.filterBy.modifier
short:
  v: missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
definition:
  v: Modifier applied to this filter parameter.
comment:
  v: Must be a modifier allowed by the SubscriptionTopic relevant to this Subscription filter.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.filterBy.modifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
condition:
  v: scr-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SearchModifierCode
  strength:
    v: required
  description:
    v: Search Modifier Code applied to this filter.
  value set:
    v: http://hl7.org/fhir/ValueSet/search-modifier-code|5.0.0
    link: 5.0
    link: .0

id:
  v: Subscription.filterBy.value
path:
  v: Subscription.filterBy.value
short:
  v: Literal value or resource path
definition:
  v: The literal value or resource path as is legal in search - for example, `Patient/123` or `le1950`.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.filterBy.value
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.channelType
path:
  v: Subscription.channelType
short:
  v: Set to "message"
definition:
  v: The type of channel to send notifications on.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.channelType
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: Coding
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SubscriptionChannelType
  strength:
    v: extensible
  description:
    v: The type of method used to execute a subscription.
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-channel-type
    link: http://hl7.org/fhir/ValueSet/subscription-channel-type

id:
  v: Subscription.endpoint
path:
  v: Subscription.endpoint
short:
  v: Where the channel points to
definition:
  v: The url that describes the actual end-point to send notifications to.
comment:
  v: For rest-hook the end-point must be an `http:` or `https:` URL; for websockets, `ws:` or `wss:`; for email, a `mailto:` url; and for message the endpoint can be in any form of url the server understands (usually, `http/s`: or `mllp:`). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.endpoint
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: url
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.parameter
path:
  v: Subscription.parameter
short:
  v: Channel type
definition:
  v: Channel-dependent information to send as part of the notification (e.g., HTTP Headers).
comment:
  v: Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Subscription.parameter
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: Subscription.parameter.id
path:
  v: Subscription.parameter.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
condition:
  v: ele-1
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Subscription.parameter.extension
path:
  v: Subscription.parameter.extension
short:
  v: Additional content defined by implementations
definition:
  v: 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 managable, 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.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Subscription.parameter.modifierExtension
path:
  v: Subscription.parameter.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 managable, 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. 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).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Subscription.parameter.name
path:
  v: Subscription.parameter.name
short:
  v: Name (key) of the parameter
definition:
  v: Parameter name for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the name would be Authorization.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.parameter.name
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: Subscription.parameter.value
path:
  v: Subscription.parameter.value
short:
  v: Value of the parameter to use or pass through
definition:
  v: Parameter value for information passed to the channel for notifications, for example in the case of a REST hook wanting to pass through an authorization header, the value would be `Bearer 0193...`.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Subscription.parameter.value
  min:
    v: 1
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: false

id:
  v: Subscription.heartbeatPeriod
path:
  v: Subscription.heartbeatPeriod
short:
  v: Interval in seconds to send 'heartbeat' notification
definition:
  v: If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.heartbeatPeriod
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: unsignedInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.timeout
path:
  v: Subscription.timeout
short:
  v: Timeout in seconds to attempt notification delivery
definition:
  v: If present, the maximum amount of time a server will allow before failing a notification attempt.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.timeout
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: unsignedInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

id:
  v: Subscription.contentType
path:
  v: Subscription.contentType
short:
  v: MIME type to send, or omit for no payload
definition:
  v: The MIME type to send the payload in - e.g., `application/fhir+xml` or `application/fhir+json`. Note that: * clients may request notifications in a specific FHIR version by using the [FHIR Version Parameter](http://hl7.org/fhir/R5/http.html#version-parameter) - e.g., `application/fhir+json; fhirVersion=4.0`. * additional MIME types can be allowed by channels - e.g., `text/plain` and `text/html` are defined by the Email channel.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.contentType
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/tools/StructureDefinition/binding-definition
    value:
      v: The mime type of an attachment. Any valid mime type is allowed.
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: MimeType
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding
    value:
      v: true
  strength:
    v: required
  description:
    v: BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
  value set:
    v: http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
    link: 5.0
    link: .0

id:
  v: Subscription.content
path:
  v: Subscription.content
short:
  v: empty | id-only | full-resource
definition:
  v: How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
comment:
  v: Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.content
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: SubscriptionPayloadContent
  strength:
    v: required
  description:
    v: Codes to represent how much resource content to send in the notification payload.
  value set:
    v: http://hl7.org/fhir/ValueSet/subscription-payload-content|5.0.0
    link: 5.0
    link: .0

id:
  v: Subscription.maxCount
path:
  v: Subscription.maxCount
short:
  v: Maximum number of events that can be combined in a single notification
definition:
  v: If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Subscription.maxCount
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: positiveInt
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: false
is modifier:
  v: false
is summary:
  v: true

element:
  id:
    v: Subscription
  path:
    v: Subscription
element:
  id:
    v: Subscription.identifier
  path:
    v: Subscription.identifier
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Subscription.status
  path:
    v: Subscription.status
  must support:
    v: true
element:
  id:
    v: Subscription.topic
  path:
    v: Subscription.topic
  short:
    v: Reference to the RTLS subscription topic being subscribed to (e.g. location updates)
  type:
    code:
      v: canonical
    target profile:
      v: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic
      link: http://hl7.org/fhir/uv/rtls/StructureDefinition/rtlsSubscriptionTopic
  must support:
    v: true
element:
  id:
    v: Subscription.channelType
  path:
    v: Subscription.channelType
  short:
    v: Set to "message"
  must support:
    v: true
element:
  id:
    v: Subscription.endpoint
  path:
    v: Subscription.endpoint
  must support:
    v: true