Belgian MyCareNet Profiles
2.1.1 - STU Belgium flag

This page is part of the HL7 Belgium FHIR Implementation Guide - MyCareNet profiles (v2.1.1: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: MyCareNet eAgreement Demand Reply Bundle BE profile

Official URL: https://www.ehealth.fgov.be/standards/fhir/mycarenet/StructureDefinition/be-eagreementdemandreply Version: 2.1.1
Standards status: Trial-use Maturity Level: 1 Computable Name: BeMyCareNetEagreementDemandReply

The profile for the reply on a demand for an agreement in the MyCareNet flows.

Usages:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(4.0.1) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... id SΣ 1..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... timestamp SΣ 1..1 instant When the bundle was assembled
... Slices for entry ΣC 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by type:resource
Constraints: bdl-5, bdl-8
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
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... entry:messageHeader SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BeMyCareNetMessageHeader(2.1.1) A resource that describes a message that is exchanged between systems
.... entry:practitioner SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BePractitioner(2.1.2) A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BePractitionerRole(2.1.2) Roles/organizations the practitioner is associated with
.... entry:claimResponse SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BeMyCareNetEagreementClaimResponse(2.1.1) Response to a claim predetermination or preauthorization
.... entry:operationOutcome SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BeMyCareNetOperationOutcome(2.1.1) Information about the success/failure of an action
...... id SΣ 1..1 id Logical id of this artifact
...... meta SΣ 1..1 Meta Metadata about the resource
....... profile Σ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
...... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
...... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
...... issue SΣ 1..* BackboneElement A single issue associated with the action
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
....... severity SΣ 1..1 code fatal | error | warning | information
Binding: IssueSeverity (required): How the issue affects the success of the action.
....... code SΣ 1..1 code Error or warning code
Binding: IssueType (required): A code that describes the type of issue.
....... details SΣ 1..1 CodeableConcept Additional details about the error
Binding: OperationOutcomeCodes (example): A code that provides details as the exact issue.
........ coding Σ 0..1 Coding Code defined by a terminology system
Binding: BeVSEagreementErrors (2.1.1) (extensible)
......... system Σ 1..1 uri Identity of the terminology system
......... code Σ 1..1 code Symbol in syntax defined by the system
....... expression SΣ 1..1 string FHIRPath of element(s) related to issue
.... entry:organization SΣC 1..2 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BeOrganization(2.1.2) A grouping of people or organizations with a common purpose
.... entry:patient SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 BePatient(2.1.2) Information about an individual or animal receiving health care services

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Bundle.typerequiredBundleType
http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
From the FHIR Standard
Bundle.entry:operationOutcome.resource.issue.severityrequiredIssueSeverity
http://hl7.org/fhir/ValueSet/issue-severity|4.0.1
From the FHIR Standard
Bundle.entry:operationOutcome.resource.issue.coderequiredIssueType
http://hl7.org/fhir/ValueSet/issue-type|4.0.1
From the FHIR Standard
Bundle.entry:operationOutcome.resource.issue.detailsexampleOperationOutcomeCodes
http://hl7.org/fhir/ValueSet/operation-outcome|4.0.1
From the FHIR Standard
Bundle.entry:operationOutcome.resource.issue.details.codingextensibleBeVSEagreementErrors(a valid code from CodeSystem agreement errors)
https://www.ehealth.fgov.be/standards/fhir/mycarenet/ValueSet/be-vs-eagreementerrors|2.1.1
From this IG

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:claimResponse, Bundle.entry:operationOutcome, Bundle.entry:organization, Bundle.entry:patientmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:messageHeader, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:claimResponse, Bundle.entry:operationOutcome, Bundle.entry:organization, Bundle.entry:patientfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1errorBundle.meta, Bundle.meta.profile, Bundle.implicitRules, Bundle.type, Bundle.timestamp, Bundle.entry, Bundle.entry.modifierExtension, Bundle.entry:messageHeader, Bundle.entry:messageHeader.modifierExtension, Bundle.entry:messageHeader.fullUrl, Bundle.entry:practitioner, Bundle.entry:practitioner.modifierExtension, Bundle.entry:practitioner.fullUrl, Bundle.entry:practitionerRole, Bundle.entry:practitionerRole.modifierExtension, Bundle.entry:practitionerRole.fullUrl, Bundle.entry:claimResponse, Bundle.entry:claimResponse.modifierExtension, Bundle.entry:claimResponse.fullUrl, Bundle.entry:operationOutcome, Bundle.entry:operationOutcome.modifierExtension, Bundle.entry:operationOutcome.fullUrl, Bundle.entry:operationOutcome.resource.meta, Bundle.entry:operationOutcome.resource.meta.profile, Bundle.entry:operationOutcome.resource.implicitRules, Bundle.entry:operationOutcome.resource.modifierExtension, Bundle.entry:operationOutcome.resource.issue, Bundle.entry:operationOutcome.resource.issue.modifierExtension, Bundle.entry:operationOutcome.resource.issue.severity, Bundle.entry:operationOutcome.resource.issue.code, Bundle.entry:operationOutcome.resource.issue.details, Bundle.entry:operationOutcome.resource.issue.details.coding, Bundle.entry:operationOutcome.resource.issue.details.coding.system, Bundle.entry:operationOutcome.resource.issue.details.coding.code, Bundle.entry:operationOutcome.resource.issue.expression, Bundle.entry:organization, Bundle.entry:organization.modifierExtension, Bundle.entry:organization.fullUrl, Bundle.entry:patient, Bundle.entry:patient.modifierExtension, Bundle.entry:patient.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.modifierExtension, Bundle.entry:messageHeader.modifierExtension, Bundle.entry:practitioner.modifierExtension, Bundle.entry:practitionerRole.modifierExtension, Bundle.entry:claimResponse.modifierExtension, Bundle.entry:operationOutcome.modifierExtension, Bundle.entry:operationOutcome.resource.modifierExtension, Bundle.entry:operationOutcome.resource.issue.modifierExtension, Bundle.entry:organization.modifierExtension, Bundle.entry:patient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron