Primary Care
0.1.0-dft-preBallot 
dft-preBallot - This is the first draft of the P-Care IG. For a full list of available versions, see the Directory of published versions
Subscription
Links
Profile
Derived from
http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription
Examples
Description
The P-Care profile for requesting event notifications from a FHIR server.
References to this resource
Resource Content
| PCareSubscription (Subscription) | C | BackportSubscription | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | 0..* | Resource | |
| extension | O C | 1..* | Extension |
| managingEntity | O C | 1..1 | Extension(Reference(Device)) |
| modifierExtension | ?! C | 0..* | Extension |
| status | Σ ?! | 1..1 | codeBinding |
| contact | Σ C | 0..* | ContactPoint |
| end | Σ | 0..1 | instant |
| reason | Σ | 1..1 | string |
| criteria | SO Σ | 1..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| filterCriteria | SO Σ C | 0..* | Extension(string) |
| value | 0..1 | System.String | |
| error | Σ | 0..1 | string |
| channel | O Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| heartbeatPeriod | C | 0..1 | Extension(unsignedInt) |
| timeout | C | 0..1 | Extension(unsignedInt) |
| maxCount | C | 0..1 | Extension(positiveInt) |
| notificationRetryPeriod | C | 0..* | Extension(Complex) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | Σ | 1..1 | codeBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| customChannelType | SO Σ C | 0..1 | Extension(Coding) |
| value | 0..1 | System.String | |
| endpoint | O Σ | 0..1 | url |
| payload | Σ | 1..1 | codeBinding |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| content | SO Σ C | 1..1 | Extension(code) |
| value | 0..1 | System.String | |
| header | Σ | 0..* | string |
| PCareSubscription (Subscription) | C | BackportSubscription | |
| id | Σ | 0..1 | id |
| meta | Σ | 0..1 | Meta |
| implicitRules | Σ ?! | 0..1 | uri |
| language | 0..1 | codeBinding | |
| text | 0..1 | Narrative | |
| contained | C | 0..* | Resource |
| extension | O C | 1..* | Extension |
| managingEntity | O C | 1..1 | Extension(Reference(Device)) |
| modifierExtension | ?! C | 0..* | Extension |
| status | Σ ?! | 1..1 | codeBinding |
| contact | Σ | 0..* | ContactPoint |
| end | Σ | 0..1 | instant |
| reason | Σ | 1..1 | string |
| criteria | SO Σ | 1..1 | string |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| filterCriteria | SO Σ C | 0..* | Extension(string) |
| value | 0..1 | System.String | |
| error | Σ | 0..1 | string |
| channel | O Σ | 1..1 | BackboneElement |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| heartbeatPeriod | C | 0..1 | Extension(unsignedInt) |
| timeout | C | 0..1 | Extension(unsignedInt) |
| maxCount | C | 0..1 | Extension(positiveInt) |
| notificationRetryPeriod | C | 0..* | Extension(Complex) |
| modifierExtension | Σ ?! C | 0..* | Extension |
| type | Σ | 1..1 | codeBinding |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| customChannelType | SO Σ C | 0..1 | Extension(Coding) |
| value | 0..1 | System.String | |
| endpoint | O Σ | 0..1 | url |
| payload | Σ | 1..1 | codeBinding |
| id | 0..1 | string | |
| extension | C | 1..* | Extension |
| content | SO Σ C | 1..1 | Extension(code) |
| value | 0..1 | System.String | |
| header | Σ | 0..* | string |
--- We have skipped the narrative for better readability of the resource ---
</text>
</mapping>
</mapping>
<baseDefinition value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription" />
</extension>
<definition value="The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action." />
</base>
<human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" />
</constraint>
<human value="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 value="contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()" />
<xpath value="not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))" />
</constraint>
<human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" />
<xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" />
</constraint>
<human value="If a resource is contained in another resource, it SHALL NOT have a security label" />
</constraint>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation">
<valueMarkdown value="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>
</constraint>
</mapping>
</mapping>
</mapping>
</element>
<definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." />
<comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." />
</base>
</extension>
</type>
</element>
<definition value="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." />
</base>
</type>
</constraint>
</element>
<definition value="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 value="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 it's narrative along with other profiles, value sets, etc." />
</base>
</type>
</constraint>
<isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" />
</element>
<comment value="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)." />
</base>
</type>
</constraint>
</extension>
</extension>
</binding>
</element>
<definition value="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 value="Contained resources do not have 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." />
</base>
</type>
</constraint>
</mapping>
</element>
<definition value="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." />
<comment value="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." />
</base>
</type>
<human value="Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems" />
<expression value="($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)" />
<xpath value="not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)" />
</constraint>
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
</discriminator>
</slicing>
</base>
</type>
</constraint>
</constraint>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
<definition value="The entity responsible for managing the subscription. Backported from R5 Subscription.managingEntity." />
</base>
<profile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-managing-entity" />
</type>
</constraint>
</constraint>
</element>
<definition value="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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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 value="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/R4/extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" />
</mapping>
</element>
<definition value="The status of the subscription, which marks the server state for managing the subscription." />
<comment value="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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid." />
</base>
</type>
</constraint>
<isModifierReason value="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" />
</extension>
</binding>
</mapping>
</element>
<definition value="Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting." />
</base>
</type>
</constraint>
</mapping>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</element>
</base>
</type>
</constraint>
</mapping>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
<definition value="When using topic-based subscriptions, the primary criteria is always the topic, indicated by its canonical URL." />
<comment value="The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading "/"." />
</base>
</type>
</constraint>
</element>
</base>
</extension>
</type>
</element>
</discriminator>
</slicing>
</base>
</type>
</constraint>
</constraint>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
</base>
<profile value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria" />
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</constraint>
</element>
</base>
</extension>
</extension>
</type>
</element>
<definition value="A record of the last error that occurred when the server processed a notification." />
</base>
</type>
</constraint>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
<definition value="Details where to send notifications when resources are received that meet the criteria." />
</base>
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</element>
<definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." />
</base>
</extension>
</type>
</mapping>
</element>
</discriminator>
</slicing>
</base>
</type>
</constraint>
</constraint>
</element>
<definition value="If present, a 'hearbeat' notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent." />
</base>
<profile value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period" />
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</constraint>
</element>
<definition value="If present, the maximum amount of time a server will allow before failing a notification attempt." />
</base>
<profile value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout" />
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</constraint>
</element>
<definition value="If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included." />
</base>
<profile value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count" />
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</constraint>
</element>
</base>
<profile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-notification-retry-period" />
</type>
</constraint>
</constraint>
</element>
<definition value="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 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." />
<comment value="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 value="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/R4/extensibility.html#modifierExtension)." />
</base>
</type>
</constraint>
</constraint>
<isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" />
</mapping>
</element>
</base>
</type>
</constraint>
</extension>
</binding>
</element>
</base>
</extension>
</type>
</element>
</discriminator>
</slicing>
</base>
</type>
</constraint>
</constraint>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
</base>
<profile value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type" />
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</constraint>
</element>
</base>
</extension>
</extension>
</type>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
<comment value="For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: 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)." />
</base>
</type>
</constraint>
</element>
<definition value="The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type "text/plain" may also be used for Email and SMS subscriptions." />
<comment value="Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured." />
</base>
</type>
</constraint>
</extension>
</binding>
</element>
</base>
</extension>
</type>
</element>
</discriminator>
</slicing>
</base>
</type>
</constraint>
</constraint>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
<valueCanonical value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/subscription|0.1.0" />
</extension>
</extension>
<definition value="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." />
</base>
<profile value="http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content" />
</type>
<human value="All FHIR elements must have a @value or children unless an empty Parameters resource" />
</constraint>
</constraint>
</element>
</base>
</extension>
</extension>
</type>
</element>
<definition value="Use to specify additional information that will be included inside the notification payload when the notification is sent. Each entry consists of a key-value pair. This should support sending client certificates and client keys with validation to determine if it is the certificate itself or just the name." />
<comment value="This can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions." />
</base>
</type>
</constraint>
</element>
</snapshot>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</discriminator>
</slicing>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
<profile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-managing-entity" />
</type>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</element>
<profile value="http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-notification-retry-period" />
</type>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</element>
</extension>
</extension>
</extension>
</extension>
<valueMarkdown value="P-Care server population, persistence, and acceptance requirements for this element." />
</extension>
</extension>
</extension>
</element>
<definition value="Use to specify additional information that will be included inside the notification payload when the notification is sent. Each entry consists of a key-value pair. This should support sending client certificates and client keys with validation to determine if it is the certificate itself or just the name." />
<comment value="This can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions." />
</element>
</differential>
</StructureDefinition>
{
--- We have skipped the narrative for better readability of the resource ---
},
{
},
{
}
],
"baseDefinition": "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription",
{
}
],
{
"definition": "The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined \"channel\" so that another system can take an appropriate action.",
"WebHook",
"Hook",
"Routing Rule"
],
},
{
},
{
"human": "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": "contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()",
"xpath": "not(exists(for $contained in f:contained return $contained[not(exists(parent::*/descendant::f:reference/@value=concat('#', $contained/*/f:id/@value)) or exists(descendant::f:reference[@value='#']))]))",
},
{
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
},
{
},
{
{
},
{
"valueMarkdown": "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."
}
],
}
],
{
},
{
},
{
}
]
},
{
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
},
{
{
}
],
}
],
},
{
"definition": "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.",
},
],
{
}
],
},
{
"definition": "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": "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 it's narrative along with other profiles, value sets, etc.",
},
],
{
}
],
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
},
{
"comment": "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).",
},
],
{
}
],
{
},
{
}
],
}
},
{
"definition": "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": "Contained resources do not have 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.",
"narrative",
"html",
"xhtml",
"display"
],
},
],
{
}
],
]
},
{
"definition": "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.",
"comment": "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.",
"inline resources",
"anonymous resources",
"contained resources"
],
},
],
{
"human": "Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems",
"expression": "($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)",
"xpath": "not(f:Citation|f:Evidence|f:EvidenceReport|f:EvidenceVariable|f:MedicinalProductDefinition|f:PackagedProductDefinition|f:AdministrableProductDefinition|f:Ingredient|f:ClinicalUseDefinition|f:RegulatedAuthorization|f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic) or not(parent::f:Citation|parent::f:Evidence|parent::f:EvidenceReport|parent::f:EvidenceVariable|parent::f:MedicinalProductDefinition|parent::f:PackagedProductDefinition|parent::f:AdministrableProductDefinition|parent::f:Ingredient|parent::f:ClinicalUseDefinition|parent::f:RegulatedAuthorization|parent::f:SubstanceDefinition|f:SubscriptionStatus|f:SubscriptionTopic)",
}
],
]
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
},
},
],
{
},
{
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
"definition": "The entity responsible for managing the subscription. Backported from R5 Subscription.managingEntity.",
},
{
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-managing-entity"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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": "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/R4/extensibility.html#modifierExtension).",
"extensions",
"user content"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
]
},
{
"definition": "The status of the subscription, which marks the server state for managing the subscription.",
"comment": "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.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
},
],
{
}
],
"isModifierReason": "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",
{
}
],
},
]
},
{
"definition": "Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.",
},
],
{
}
],
]
},
{
},
],
{
}
],
]
},
{
},
],
{
}
],
]
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
"definition": "When using topic-based subscriptions, the primary criteria is always the topic, indicated by its canonical URL.",
"comment": "The rules are search criteria (without the [base] part). Like Bundle.entry.request.url, it has no leading \"/\".",
},
],
{
}
],
},
{
"xmlAttr"
],
},
{
{
}
],
}
],
},
{
},
},
],
{
},
{
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
},
{
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
},
{
{
},
{
}
],
}
],
},
{
},
],
{
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
"definition": "Details where to send notifications when resources are received that meet the criteria.",
},
],
{
}
],
},
{
"xmlAttr"
],
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
},
{
{
}
],
}
],
]
},
{
},
},
],
{
},
{
}
],
},
{
"definition": "If present, a 'hearbeat' notification (keepalive) is sent via this channel with an the interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.",
},
{
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
"definition": "If present, the maximum amount of time a server will allow before failing a notification attempt.",
},
{
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-timeout"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
"definition": "If present, the maximum number of triggering resources that will be included in a notification bundle (e.g., a server will not include more than this number of trigger resources in a single notification). Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.",
},
{
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-max-count"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
},
{
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-notification-retry-period"
]
}
],
{
},
{
}
],
},
{
"definition": "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 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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": "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/R4/extensibility.html#modifierExtension).",
"extensions",
"user content",
"modifiers"
],
},
],
{
},
{
}
],
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
]
},
{
},
],
{
}
],
{
}
],
}
},
{
"xmlAttr"
],
},
{
{
}
],
}
],
},
{
},
},
],
{
},
{
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
},
{
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-channel-type"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
},
{
{
},
{
}
],
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
"comment": "For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: 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).",
},
],
{
}
],
},
{
"definition": "The mime type to send the payload in - either application/fhir+xml, or application/fhir+json. If the payload is not present, then there is no payload in the notification, just a notification. The mime type \"text/plain\" may also be used for Email and SMS subscriptions.",
"comment": "Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.",
},
],
{
}
],
{
}
],
}
},
{
"xmlAttr"
],
},
{
{
}
],
}
],
},
{
},
},
],
{
},
{
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
},
{
}
],
}
],
"definition": "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.",
},
{
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-payload-content"
]
}
],
"ele-1"
],
{
},
{
}
],
},
{
"xmlAttr"
],
},
{
{
},
{
}
],
}
],
},
{
"definition": "Use to specify additional information that will be included inside the notification payload when the notification is sent. Each entry consists of a key-value pair. This should support sending client certificates and client keys with validation to determine if it is the certificate itself or just the name.",
"comment": "This can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions.",
},
],
{
}
],
}
]
},
{
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
{
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-managing-entity"
]
}
]
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
{
{
"http://fhir.infoway-inforoute.ca/p-care/StructureDefinition/pcare-subscription-notification-retry-period"
]
}
]
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
{
{
{
},
{
},
{
},
{
},
{
"valueMarkdown": "P-Care server population, persistence, and acceptance requirements for this element."
},
{
}
],
}
],
},
{
"definition": "Use to specify additional information that will be included inside the notification payload when the notification is sent. Each entry consists of a key-value pair. This should support sending client certificates and client keys with validation to determine if it is the certificate itself or just the name.",
"comment": "This can convey additional information to the recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions."
}
]
}
}
Constraints
Obligations
| Element | Actor | Code |
|---|---|---|
| channel | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| channel.endpoint | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| channel.payload.extension:content | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| channel.type.extension:customChannelType | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| criteria | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| criteria.extension:filterCriteria | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| extension | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
| extension:managingEntity | http://fhir.infoway-inforoute.ca/p-care/ActorDefinition/pcare-server | SHALL:populate, SHALL:persist, SHALL:no-error |
Terminology bindings (Differential)
Terminology bindings (Snapshot)
| Path | Conformance | ValueSet |
|---|---|---|
| Subscription.language | preferred | http://hl7.org/fhir/ValueSet/languages |
| Subscription.status | required | http://hl7.org/fhir/ValueSet/subscription-status|4.0.0 |
| Subscription.channel.type | required | http://hl7.org/fhir/ValueSet/subscription-channel-type|4.0.0 |
| Subscription.channel.payload | required | http://hl7.org/fhir/ValueSet/mimetypes|4.0.0 |