FHIRcast, published by HL7 International / Infrastructure And Messaging. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhircast-docs/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/fhircast/StructureDefinition/fhircast-hibernate | Version: 3.0.0-ballot | |||
Draft as of 2024-12-19 | Computable Name: FHIRcastHibernateContext |
Contains the rationale behind the userHibernate event
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Slices for parameter | S | 1..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name |
parameter:code | 1..1 | BackboneElement | Coded reason. | |
name | 1..1 | string | Name from the definition Required Pattern: code | |
value[x] | 1..1 | Coding | Coded reason. Binding: Reasons for sending a userHibernate event. (extensible) | |
resource | 0..0 | |||
part | 0..0 | |||
parameter:hub | 0..1 | BackboneElement | Whether the system hosting the Hub will hibernate. | |
name | 1..1 | string | Name from the definition Required Pattern: hub | |
value[x] | 1..1 | boolean | `true` when system hosting hub will hibernate. | |
resource | 0..0 | |||
part | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:code.value[x] | extensible | FHIRcastHibernateReasonhttp://hl7.org/fhir/uv/fhircast/ValueSet/FHIRcastHibernateReason from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for parameter | SΣC | 1..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part) |
parameter:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children |
parameter:code | ΣC | 1..1 | BackboneElement | Coded reason. ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: code |
value[x] | ΣC | 1..1 | Coding | Coded reason. Binding: Reasons for sending a userHibernate event. (extensible) ele-1: All FHIR elements must have a @value or children |
parameter:hub | ΣC | 0..1 | BackboneElement | Whether the system hosting the Hub will hibernate. ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: hub |
value[x] | ΣC | 1..1 | boolean | `true` when system hosting hub will hibernate. ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:code.value[x] | extensible | FHIRcastHibernateReasonhttp://hl7.org/fhir/uv/fhircast/ValueSet/FHIRcastHibernateReason from this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:code, Parameters.parameter:hub | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | SΣC | 1..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part) | ||||
parameter:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | Name from the definition | ||||
value[x] | ΣC | 0..1 | If parameter is a data type | |||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
resource | ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
parameter:code | ΣC | 1..1 | BackboneElement | Coded reason. inv-1: A parameter must have one and only one of (value, resource, part) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | Name from the definition Required Pattern: code | ||||
value[x] | ΣC | 1..1 | Coding | Coded reason. Binding: Reasons for sending a userHibernate event. (extensible) | ||||
parameter:hub | ΣC | 0..1 | BackboneElement | Whether the system hosting the Hub will hibernate. inv-1: A parameter must have one and only one of (value, resource, part) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | Name from the definition Required Pattern: hub | ||||
value[x] | ΣC | 1..1 | boolean | `true` when system hosting hub will hibernate. | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Parameters.parameter:code.value[x] | extensible | FHIRcastHibernateReasonhttp://hl7.org/fhir/uv/fhircast/ValueSet/FHIRcastHibernateReason from this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:code, Parameters.parameter:hub | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
This structure is derived from Parameters
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 1 element
Prohibited: 4 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Slices for parameter | S | 1..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name |
parameter:code | 1..1 | BackboneElement | Coded reason. | |
name | 1..1 | string | Name from the definition Required Pattern: code | |
value[x] | 1..1 | Coding | Coded reason. Binding: Reasons for sending a userHibernate event. (extensible) | |
resource | 0..0 | |||
part | 0..0 | |||
parameter:hub | 0..1 | BackboneElement | Whether the system hosting the Hub will hibernate. | |
name | 1..1 | string | Name from the definition Required Pattern: hub | |
value[x] | 1..1 | boolean | `true` when system hosting hub will hibernate. | |
resource | 0..0 | |||
part | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:code.value[x] | extensible | FHIRcastHibernateReasonhttp://hl7.org/fhir/uv/fhircast/ValueSet/FHIRcastHibernateReason from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
Slices for parameter | SΣC | 1..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part) |
parameter:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children |
parameter:code | ΣC | 1..1 | BackboneElement | Coded reason. ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: code |
value[x] | ΣC | 1..1 | Coding | Coded reason. Binding: Reasons for sending a userHibernate event. (extensible) ele-1: All FHIR elements must have a @value or children |
parameter:hub | ΣC | 0..1 | BackboneElement | Whether the system hosting the Hub will hibernate. ele-1: All FHIR elements must have a @value or children inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
name | Σ | 1..1 | string | Name from the definition ele-1: All FHIR elements must have a @value or children Required Pattern: hub |
value[x] | ΣC | 1..1 | boolean | `true` when system hosting hub will hibernate. ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Parameters.parameter:code.value[x] | extensible | FHIRcastHibernateReasonhttp://hl7.org/fhir/uv/fhircast/ValueSet/FHIRcastHibernateReason from this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:code, Parameters.parameter:hub | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | SΣC | 1..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part) | ||||
parameter:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | Name from the definition | ||||
value[x] | ΣC | 0..1 | If parameter is a data type | |||||
valueBase64Binary | base64Binary | |||||||
valueBoolean | boolean | |||||||
valueCanonical | canonical(Any) | |||||||
valueCode | code | |||||||
valueDate | date | |||||||
valueDateTime | dateTime | |||||||
valueDecimal | decimal | |||||||
valueId | id | |||||||
valueInstant | instant | |||||||
valueInteger | integer | |||||||
valueMarkdown | markdown | |||||||
valueOid | oid | |||||||
valuePositiveInt | positiveInt | |||||||
valueString | string | |||||||
valueTime | time | |||||||
valueUnsignedInt | unsignedInt | |||||||
valueUri | uri | |||||||
valueUrl | url | |||||||
valueUuid | uuid | |||||||
valueAddress | Address | |||||||
valueAge | Age | |||||||
valueAnnotation | Annotation | |||||||
valueAttachment | Attachment | |||||||
valueCodeableConcept | CodeableConcept | |||||||
valueCoding | Coding | |||||||
valueContactPoint | ContactPoint | |||||||
valueCount | Count | |||||||
valueDistance | Distance | |||||||
valueDuration | Duration | |||||||
valueHumanName | HumanName | |||||||
valueIdentifier | Identifier | |||||||
valueMoney | Money | |||||||
valuePeriod | Period | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueRatio | Ratio | |||||||
valueReference | Reference(Any) | |||||||
valueSampledData | SampledData | |||||||
valueSignature | Signature | |||||||
valueTiming | Timing | |||||||
valueContactDetail | ContactDetail | |||||||
valueContributor | Contributor | |||||||
valueDataRequirement | DataRequirement | |||||||
valueExpression | Expression | |||||||
valueParameterDefinition | ParameterDefinition | |||||||
valueRelatedArtifact | RelatedArtifact | |||||||
valueTriggerDefinition | TriggerDefinition | |||||||
valueUsageContext | UsageContext | |||||||
valueDosage | Dosage | |||||||
valueMeta | Meta | |||||||
resource | ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
part | Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
parameter:code | ΣC | 1..1 | BackboneElement | Coded reason. inv-1: A parameter must have one and only one of (value, resource, part) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | Name from the definition Required Pattern: code | ||||
value[x] | ΣC | 1..1 | Coding | Coded reason. Binding: Reasons for sending a userHibernate event. (extensible) | ||||
parameter:hub | ΣC | 0..1 | BackboneElement | Whether the system hosting the Hub will hibernate. inv-1: A parameter must have one and only one of (value, resource, part) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | Name from the definition Required Pattern: hub | ||||
value[x] | ΣC | 1..1 | boolean | `true` when system hosting hub will hibernate. | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Parameters.parameter:code.value[x] | extensible | FHIRcastHibernateReasonhttp://hl7.org/fhir/uv/fhircast/ValueSet/FHIRcastHibernateReason from this IG |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:code, Parameters.parameter:hub | A parameter must have one and only one of (value, resource, part) : (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())) |
This structure is derived from Parameters
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 1 element
Prohibited: 4 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron