1.0.1 - ci-build
KLGatewayMunicipalityCareData - Local Development build (v1.0.1). See the Directory of published versions
Official URL: http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-delivery-report | Version: 1.0.1 | |||
Draft as of 2023-08-21 | Computable Name: KLGatewayCareDeliveryReport |
Deliver report to deliver for each citizen.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources gateway-care-report-1: All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation |
identifier | 0..0 | |||
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: collection | |
timestamp | 1..1 | instant | When the bundle was assembled | |
total | 0..0 | |||
link | 0..0 | |||
entry | ||||
resource | 1..1 | Content constrained to known profiles (see also constraint gateway-care-report-1) | ||
resource | Patient(KLGatewayCareCitizen) | |||
resource | Condition(KLGatewayCareCondition) | |||
resource | Goal(KLGatewayCareGoal) | |||
resource | CarePlan(KLGatewayCarePlannedIntervention) | |||
resource | Procedure(KLGatewayCareCompletedIntervention) | |||
resource | Encounter(KLGatewayCareEncounter) | |||
resource | Observation | |||
search | 0..0 | |||
request | 0..0 | |||
response | 0..0 | |||
signature | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gateway-care-report-1 | error | Bundle | All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation : entry.ofType(Observation).all( resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-citizens-own-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-matter-of-interest-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-follow-up-observation')) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources gateway-care-report-1: All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection |
timestamp | Σ | 1..1 | instant | When the bundle was assembled |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Pattern: collection |
Id | Grade | Path(s) | Details | Requirements |
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
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() | |
gateway-care-report-1 | error | Bundle | All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation : entry.ofType(Observation).all( resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-citizens-own-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-matter-of-interest-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-follow-up-observation')) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources gateway-care-report-1: All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation | ||||
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.
| |||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection | ||||
timestamp | Σ | 1..1 | instant | When the bundle was assembled | ||||
entry | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
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 | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
resource | Σ | 1..1 | Content constrained to known profiles (see also constraint gateway-care-report-1) | |||||
resource | Patient(KLGatewayCareCitizen) | |||||||
resource | Condition(KLGatewayCareCondition) | |||||||
resource | Goal(KLGatewayCareGoal) | |||||||
resource | CarePlan(KLGatewayCarePlannedIntervention) | |||||||
resource | Procedure(KLGatewayCareCompletedIntervention) | |||||||
resource | Encounter(KLGatewayCareEncounter) | |||||||
resource | Observation | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Bundle.language | preferred | CommonLanguages
| ||||
Bundle.type | required | Pattern: collection | ||||
Bundle.entry.search.mode | required | SearchEntryMode | ||||
Bundle.entry.request.method | required | HTTPVerb |
Id | Grade | Path(s) | Details | Requirements |
bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
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() |
This structure is derived from Bundle
Summary
Mandatory: 1 element (1 nested mandatory element)
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources gateway-care-report-1: All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation |
identifier | 0..0 | |||
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: collection | |
timestamp | 1..1 | instant | When the bundle was assembled | |
total | 0..0 | |||
link | 0..0 | |||
entry | ||||
resource | 1..1 | Content constrained to known profiles (see also constraint gateway-care-report-1) | ||
resource | Patient(KLGatewayCareCitizen) | |||
resource | Condition(KLGatewayCareCondition) | |||
resource | Goal(KLGatewayCareGoal) | |||
resource | CarePlan(KLGatewayCarePlannedIntervention) | |||
resource | Procedure(KLGatewayCareCompletedIntervention) | |||
resource | Encounter(KLGatewayCareEncounter) | |||
resource | Observation | |||
search | 0..0 | |||
request | 0..0 | |||
response | 0..0 | |||
signature | 0..0 | |||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
gateway-care-report-1 | error | Bundle | All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation : entry.ofType(Observation).all( resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-citizens-own-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-matter-of-interest-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-follow-up-observation')) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources gateway-care-report-1: All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection |
timestamp | Σ | 1..1 | instant | When the bundle was assembled |
Documentation for this format |
Path | Conformance | ValueSet / Code |
Bundle.type | required | Pattern: collection |
Id | Grade | Path(s) | Details | Requirements |
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
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() | |
gateway-care-report-1 | error | Bundle | All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation : entry.ofType(Observation).all( resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-citizens-own-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-matter-of-interest-observation') or resource.conformsTo('http://municipality-care-data.gateway.kl.dk/1.0/StructureDefinition/klgateway-care-follow-up-observation')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Bundle | C | 0..* | Bundle | Contains a collection of resources gateway-care-report-1: All observation resources shall conform to either klgateway-care-citizens-own-observation profile, klgateway-care-matter-of-interest-observation, or klgateway-care-follow-up-observation | ||||
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.
| |||||
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: collection | ||||
timestamp | Σ | 1..1 | instant | When the bundle was assembled | ||||
entry | ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
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 | ||||
link | Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
resource | Σ | 1..1 | Content constrained to known profiles (see also constraint gateway-care-report-1) | |||||
resource | Patient(KLGatewayCareCitizen) | |||||||
resource | Condition(KLGatewayCareCondition) | |||||||
resource | Goal(KLGatewayCareGoal) | |||||||
resource | CarePlan(KLGatewayCarePlannedIntervention) | |||||||
resource | Procedure(KLGatewayCareCompletedIntervention) | |||||||
resource | Encounter(KLGatewayCareEncounter) | |||||||
resource | Observation | |||||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
Bundle.language | preferred | CommonLanguages
| ||||
Bundle.type | required | Pattern: collection | ||||
Bundle.entry.search.mode | required | SearchEntryMode | ||||
Bundle.entry.request.method | required | HTTPVerb |
Id | Grade | Path(s) | Details | Requirements |
bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
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() |
This structure is derived from Bundle
Summary
Mandatory: 1 element (1 nested mandatory element)
Prohibited: 7 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron