Module health.fhir.r4.be.core200
ballerinax/health.fhir.r4.be.core200 Ballerina library
1.0.0
Ballerina package containing FHIR resource data models compliant with https://www.ehealth.fgov.be/standards/fhir/core/ implementation guide.
FHIR R4 health_fhir_r4_be_core200 package
Package Overview
| FHIR version | R4 |
| Implementation Guide | https://www.ehealth.fgov.be/standards/fhir/core/ |
Note: This package only supports FHIR JSON payload format only. FHIR XML payload support will be added soon.
Capabilities and features
Supported FHIR resource types
| 1). BePatient | [Definition] [Ballerina Record] |
| 2). BePractitioner | [Definition] [Ballerina Record] |
| 3). BeDocumentReference | [Definition] [Ballerina Record] |
| 4). BeCommunication | [Definition] [Ballerina Record] |
| 5). BeOrganization | [Definition] [Ballerina Record] |
| 6). BePractitionerRole | [Definition] [Ballerina Record] |
| 7). BeProvenance | [Definition] [Ballerina Record] |
Functions
initialize
Isolated Function
function initialize()This empty function is used to initialize the module by other modules/packages.
Constants
health.fhir.r4.be.core200: PROFILE_BASE_BECOMMUNICATION
health.fhir.r4.be.core200: PROFILE_BASE_BEDOCUMENTREFERENCE
health.fhir.r4.be.core200: PROFILE_BASE_BEORGANIZATION
health.fhir.r4.be.core200: PROFILE_BASE_BEPATIENT
health.fhir.r4.be.core200: PROFILE_BASE_BEPRACTITIONER
health.fhir.r4.be.core200: PROFILE_BASE_BEPRACTITIONERROLE
health.fhir.r4.be.core200: PROFILE_BASE_BEPROVENANCE
health.fhir.r4.be.core200: RESOURCE_NAME_BECOMMUNICATION
health.fhir.r4.be.core200: RESOURCE_NAME_BEDOCUMENTREFERENCE
health.fhir.r4.be.core200: RESOURCE_NAME_BEORGANIZATION
health.fhir.r4.be.core200: RESOURCE_NAME_BEPATIENT
health.fhir.r4.be.core200: RESOURCE_NAME_BEPRACTITIONER
health.fhir.r4.be.core200: RESOURCE_NAME_BEPRACTITIONERROLE
health.fhir.r4.be.core200: RESOURCE_NAME_BEPROVENANCE
Enums
health.fhir.r4.be.core200: BeAddressType
Members
CODE_BEADDRESSTYPE_POSTAL
CODE_BEADDRESSTYPE_PHYSICAL
CODE_BEADDRESSTYPE_BOTH
health.fhir.r4.be.core200: BeAddressUse
Members
CODE_BEADDRESSUSE_TEMP
CODE_BEADDRESSUSE_WORK
CODE_BEADDRESSUSE_OLD
CODE_BEADDRESSUSE_HOME
CODE_BEADDRESSUSE_BILLING
health.fhir.r4.be.core200: BeCommunicationPriority
BeCommunicationPriority enum
Members
CODE_PRIORITY_STAT
CODE_PRIORITY_ROUTINE
CODE_PRIORITY_URGENT
CODE_PRIORITY_ASAP
health.fhir.r4.be.core200: BeCommunicationStatus
BeCommunicationStatus enum
Members
CODE_STATUS_STOPPED
CODE_STATUS_COMPLETED
CODE_STATUS_NOT_DONE
CODE_STATUS_ENTERED_IN_ERROR
CODE_STATUS_IN_PROGRESS
CODE_STATUS_ON_HOLD
CODE_STATUS_PREPARATION
CODE_STATUS_UNKNOWN
health.fhir.r4.be.core200: BeDocumentReferenceDocStatus
BeDocumentReferenceDocStatus enum
Members
CODE_DOCSTATUS_AMENDED
CODE_DOCSTATUS_FINAL
CODE_DOCSTATUS_PRELIMINARY
CODE_DOCSTATUS_ENTERED_IN_ERROR
health.fhir.r4.be.core200: BeDocumentReferenceRelatesToCode
BeDocumentReferenceRelatesToCode enum
Members
CODE_CODE_SIGNS
CODE_CODE_REPLACES
CODE_CODE_TRANSFORMS
CODE_CODE_APPENDS
health.fhir.r4.be.core200: BeDocumentReferenceStatus
BeDocumentReferenceStatus enum
Members
CODE_STATUS_CURRENT
CODE_STATUS_SUPERSEDED
CODE_STATUS_ENTERED_IN_ERROR
health.fhir.r4.be.core200: BeOrganizationIdentifierUse
BeOrganizationIdentifierUse enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BeOrganizationIdentifierUseOne
BeOrganizationIdentifierUseOne enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BeOrganizationIdentifierUseTwo
BeOrganizationIdentifierUseTwo enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BePatientContactGender
BePatientContactGender enum
Members
CODE_GENDER_OTHER
CODE_GENDER_FEMALE
CODE_GENDER_MALE
CODE_GENDER_UNKNOWN
health.fhir.r4.be.core200: BePatientGender
BePatientGender enum
Members
CODE_GENDER_OTHER
CODE_GENDER_FEMALE
CODE_GENDER_MALE
CODE_GENDER_UNKNOWN
health.fhir.r4.be.core200: BePatientIdentifierUse
BePatientIdentifierUse enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BePatientLinkType
BePatientLinkType enum
Members
CODE_TYPE_REFER
CODE_TYPE_REPLACES
CODE_TYPE_SEEALSO
CODE_TYPE_REPLACED_BY
health.fhir.r4.be.core200: BePractitionerGender
BePractitionerGender enum
Members
CODE_GENDER_OTHER
CODE_GENDER_FEMALE
CODE_GENDER_MALE
CODE_GENDER_UNKNOWN
health.fhir.r4.be.core200: BePractitionerIdentifierUse
BePractitionerIdentifierUse enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BePractitionerIdentifierUseOne
BePractitionerIdentifierUseOne enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BePractitionerIdentifierUseTwo
BePractitionerIdentifierUseTwo enum
Members
CODE_USE_SECONDARY
CODE_USE_TEMP
CODE_USE_USUAL
CODE_USE_OLD
CODE_USE_OFFICIAL
health.fhir.r4.be.core200: BePractitionerRoleAvailableTimeDaysOfWeek
BePractitionerRoleAvailableTimeDaysOfWeek enum
Members
CODE_DAYSOFWEEK_THU
CODE_DAYSOFWEEK_TUE
CODE_DAYSOFWEEK_WED
CODE_DAYSOFWEEK_SAT
CODE_DAYSOFWEEK_FRI
CODE_DAYSOFWEEK_MON
CODE_DAYSOFWEEK_SUN
health.fhir.r4.be.core200: BeProvenanceEntityRole
BeProvenanceEntityRole enum
Members
CODE_ROLE_REMOVAL
CODE_ROLE_DERIVATION
CODE_ROLE_SOURCE
CODE_ROLE_QUOTATION
CODE_ROLE_REVISION
Variables
health.fhir.r4.be.core200: terminologyProcessor
Terminology processor instance
health.fhir.r4.be.core200: fhirRegistry
FHIR registry instance
health.fhir.r4.be.core200: FHIR_VALUE_SETS
health.fhir.r4.be.core200: FHIR_CODE_SYSTEMS
Records
health.fhir.r4.be.core200: BeAddress
Closed record
Fields
- Fields Included from *Address
- id? string -
- extension? Extension[] -
- country? string -
- period? Period -
- city? string -
- use? BeAddressUse -
- line? string[] -
- district? string -
- postalCode? string -
- text? string -
- state? string -
- 'type? BeAddressType -
- value? string -
health.fhir.r4.be.core200: BeCodedAnnotation
Closed record
Fields
- Fields Included from *Annotation
- id? string -
- extension? Extension[] -
- time? dateTime -
- text markdown -
health.fhir.r4.be.core200: BeCommunication
FHIR BeCommunication resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BECOMMUNICATION(default RESOURCE_NAME_BECOMMUNICATION) - The type of the resource describes
- note? Annotation[] - Additional notes or commentary about the communication by the sender, receiver or other interested parties.
- partOf? Reference[] - Part of this action.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
- subject Reference - The patient or group that was the focus of this communication.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- about? Reference[] - Other resources that pertain to this communication and to which this communication should be associated.
- reasonReference? Reference[] - Indicates another resource whose existence justifies this communication.
- language? code - The base language in which the resource is written.
- medium? CodeableConcept[] - A channel that was used for this communication (e.g. email, fax).
- instantiatesUri? uri[] - The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
- statusReason? CodeableConcept - Captures the reason for the current state of the Communication.
- payload? BeCommunicationPayload[] - Text, attachment(s), or resource(s) that was communicated to the recipient.
- inResponseTo? Reference[] - Prior communication that this communication is in response to.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- reasonCode? CodeableConcept[] - The reason or justification for the communication.
- text? Narrative - 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.
- basedOn? Reference[] - An order, proposal or plan fulfilled in whole or in part by this Communication.
- identifier? Identifier[] - Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
- received? dateTime - The time when this communication arrived at the destination.
- encounter? Reference - The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
- instantiatesCanonical? canonical[] - The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.
- priority? BeCommunicationPriority - Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
- sent? dateTime - The time when this communication was sent.
- contained? Resource[] - 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.
- sender Reference - The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.
- meta? Meta - 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.
- recipient? Reference[] - The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).
- implicitRules? uri - 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.
- topic? CodeableConcept - Description of the purpose/content, similar to a subject line in an email.
- category? CodeableConcept[] - The type of message conveyed such as alert, notification, reminder, instruction, etc.
- status BeCommunicationStatus - The status of the transmission.
- Element... - Rest field
health.fhir.r4.be.core200: BeCommunicationPayload
Closed record
FHIR BeCommunicationPayload datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- contentReference? Reference - A communicated content (or for multi-part communications, one portion of the communication).
- contentString? string - A communicated content (or for multi-part communications, one portion of the communication).
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- contentAttachment? Attachment - A communicated content (or for multi-part communications, one portion of the communication).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.be.core200: BeDocumentReference
FHIR BeDocumentReference resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEDOCUMENTREFERENCE(default RESOURCE_NAME_BEDOCUMENTREFERENCE) - The type of the resource describes
- date? instant - When the document reference was created.
- identifier? Identifier[] - Other identifiers associated with the document, including version independent identifiers.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
- custodian? Reference - Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
- securityLabel? CodeableConcept[] - A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the 'reference' to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to.
- subject Reference - Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure).
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description? string - Human-readable description of the source document.
- language? code - The base language in which the resource is written.
- masterIdentifier? Identifier - Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document.
- 'type? CodeableConcept - Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced.
- content BeDocumentReferenceContent[] - The document and format referenced. There may be multiple content element repetitions, each with a different format.
- contained? Resource[] - 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.
- docStatus? BeDocumentReferenceDocStatus - The status of the underlying document.
- meta? Meta - 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.
- context? BeDocumentReferenceContext - The clinical context in which the document was prepared.
- implicitRules? uri - 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.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- category? CodeableConcept[] - A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type.
- relatesTo? BeDocumentReferenceRelatesTo[] - Relationships that this document has with other document references that already exist.
- authenticator? Reference - Which person or organization authenticates that this document is valid.
- status BeDocumentReferenceStatus - The status of this document reference.
- Element... - Rest field
health.fhir.r4.be.core200: BeDocumentReferenceContent
Closed record
FHIR BeDocumentReferenceContent datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- attachment Attachment - The document or URL of the document along with critical metadata to prove content has integrity.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- format? Coding - An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.be.core200: BeDocumentReferenceContext
Closed record
FHIR BeDocumentReferenceContext datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - The time period over which the service that is described by the document was provided.
- facilityType? CodeableConcept - The kind of facility where the patient was seen.
- practiceSetting? CodeableConcept - This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- encounter? Reference[] - Describes the clinical encounter or type of care that the document content is associated with.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- event? CodeableConcept[] - This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a 'History and Physical Report' in which the procedure being documented is necessarily a 'History and Physical' act.
- sourcePatientInfo? Reference - The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
health.fhir.r4.be.core200: BeDocumentReferenceRelatesTo
Closed record
FHIR BeDocumentReferenceRelatesTo datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- code BeDocumentReferenceRelatesToCode - The type of relationship that this document has with anther document.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- target Reference - The target document of this relationship.
health.fhir.r4.be.core200: BeOrganization
FHIR BeOrganization resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEORGANIZATION(default RESOURCE_NAME_BEORGANIZATION) - The type of the resource describes
- identifier? Identifier[] - Identifier for the organization that is used to identify the organization across multiple disparate systems. Typically, a NIHDI value and/or a CBE or EHP value are given. Other systems are allowed. Flows in organizations will most likely want to also include a local identifier, using its own system. A type can be added if needed. When it is given, a consumer SHALL NOT ignore it.
- identifier Slicings
- BeOrganizationIdentifierCBE: Identifies this organization across multiple systems
- min = 0
- max = *
- partOf? Reference - The organization of which this organization forms a part.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
- address? BeAddress[] - An address for the organization. It is RECOMMENDED to include this when available
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active? boolean - Whether the organization's record is still in active use. It is RECOMMENDED to keep the value ‘true’ as long as the organization is known to be active.
- language? code - The base language in which the resource is written.
- 'type? CodeableConcept[] - The kind(s) of organization that this is. Proposed use of CD-HCPARTY to type the organisation using dept... or org... codes. Other systems remain allowed. In typical use, RECOMMENDED to type the organization. In the future, specific other systems might also be proposed from a federal level to better type an organization.
- type Slicings
- BeOrganizationTypeCD_HCPARTY: Kind of organization
- min = 0
- max = *
- contained? Resource[] - 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.
- endpoint? Reference[] - Technical endpoints providing access to services operated for the organization.
- meta? Meta - 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.
- contact? BeOrganizationContact[] - Contact for the organization for a certain purpose.
- name? string - A name associated with the organization.
- alias? string[] - A list of alternate names that the organization is known as, or was known as in the past.
- implicitRules? uri - 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.
- telecom? ContactPoint[] - A contact detail for the organization. It is RECOMMENDED to at least add one phone or email address.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- Element... - Rest field
health.fhir.r4.be.core200: BeOrganizationContact
Closed record
FHIR BeOrganizationContact datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- address? Address - Visiting or postal addresses for the contact.
- purpose? CodeableConcept - Indicates a purpose for which the contact can be reached.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- name? HumanName - A name associated with the contact.
- telecom? ContactPoint[] - A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.be.core200: BeOrganizationIdentifierCBE
Closed record
FHIR BeOrganizationIdentifierCBE datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BeOrganizationIdentifierUse - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BeOrganizationIdentifierEHP
Closed record
FHIR BeOrganizationIdentifierEHP datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ehp") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BeOrganizationIdentifierUseOne - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BeOrganizationIdentifierNIHDI
Closed record
FHIR BeOrganizationIdentifierNIHDI datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BeOrganizationIdentifierUseTwo - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BeOrganizationTypeCD_HCPARTY
Closed record
FHIR BeOrganizationTypeCD_HCPARTY datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? BeOrganizationTypeCoding[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.core200: BeOrganizationTypeCoding
Closed record
FHIR BeOrganizationTypeCoding datatype record.
Fields
- Fields Included from *Coding
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- code code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.be.core200: BePatient
FHIR BePatient resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEPATIENT(default RESOURCE_NAME_BEPATIENT) - The type of the resource describes
- extension? Extension[] - An Extension
- gender? BePatientGender - Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- link? BePatientLink[] - Link to another patient resource that concerns the same actual patient.
- language? code - The base language in which the resource is written.
- contact? BePatientContact[] - A contact party (e.g. guardian, partner, friend) for the patient. It is RECOMMENDED to include this when available and considered relevant for the patientcare. (e.g. a parent of a young patient)
- deceasedDateTime? dateTime - Indicates if the individual is deceased or not. It is RECOMMENDED to include deceased information when applicable
- generalPractitioner? Reference[] - Patient's nominated care provider. Take note this does not automatically imply any legal form of therapeutic link or consent relationship with this GP. It is RECOMMENDED to include this when available if the flow is in any way medical. Please note this is an element of the Reference datatype. This means when it is available it will contain either a relative or absolute URL where this GP can be found. Alternatively, there is only an internal reference and the GP is included as a ‘contained resource’ (cfr. the HL7 FHIR specifications in what cases this applies).
- telecom? ContactPoint[] - A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted. It is RECOMMENDED to at least add one phone or email address with clear indication using the .use element whether it is home use, private use,...
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- communication? BePatientCommunication[] - A language which may be used to communicate with the patient about his or her health. It is RECOMMENDED to include this when available.
- identifier? Identifier[] - An identifier for this patient. Typically, when SSIN is available it is used. Organizations will most likely want to also include a local identifier, using its own system. A type can be added if needed. When an identifier is given, a consumer SHALL NOT ignore it.
- identifier Slicings
- BePatientIdentifierSSIN: An identifier for this patient
- min = 0
- max = *
- address? BeAddress[] - An address for the individual. It is RECOMMENDED to include an address when available. When needed to express the availablity of a Patient at home (e.g. only Wednesdays), another solution will be defined.
- multipleBirthBoolean? boolean - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Care SHOULD be given when exchanging Patient instances in a purely administrative flow.
- active? boolean - Whether this patient record is in active use. Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.
- photo? Attachment[] - Image of the patient.
- birthDate? BePatientBirthDate|date - The date of birth for the individual. It is RECOMMENDED to give the birthdate when available.
- contained? Resource[] - 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.
- deceasedBoolean? boolean - Indicates if the individual is deceased or not. It is RECOMMENDED to include deceased information when applicable
- managingOrganization? Reference - Organization that is the custodian of the patient record. This SHOULD be included when available.Please note this is an element of the Reference datatype. This means when it is available it will contain either a relative or absolute URL where this Organization can be found. Alternatively, there is only an internal reference and the Organization is included as a ‘contained resource’ (cfr. the HL7 FHIR specifications in what cases this applies).
- meta? Meta - 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.
- multipleBirthInteger? integer - Indicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer). Care SHOULD be given when exchanging Patient instances in a purely administrative flow.
- name? HumanName[] - A name associated with the individual. It is RECOMMENDED to give at least one familyname and at least one given name when possible and define an 'official' use. When names are given, a consumer SHALL NOT ignore it.
- implicitRules? uri - 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.
- maritalStatus? CodeableConcept - This field contains a patient's most recent marital (civil) status. It is RECOMMENDED to include this when available. In a Belgian context, the concept ‘civil state’ , Dutch ‘burgerlijke stand’, French ‘état civil’ is more typically used and this might imply a more neutral concept to the reader. In HL7 semantics however this concept is described as ‘marital status’ and it SHALL be understood as the same concept.
- Element... - Rest field
health.fhir.r4.be.core200: BePatientBirthDate
Closed record
FHIR BePatientBirthDate datatype record.
Fields
- extension? Extension[] - An Extension
- id? string - unique id for the element within a resource (for internal references)
- value? date - The actual value
health.fhir.r4.be.core200: BePatientCommunication
Closed record
FHIR BePatientCommunication datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language CodeableConcept - The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. 'en' for English, or 'en-US' for American English versus 'en-EN' for England English.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- preferred? boolean - Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).
health.fhir.r4.be.core200: BePatientContact
Closed record
FHIR BePatientContact datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - The period during which this contact person or organization is valid to be contacted relating to this patient.
- address? Address - Address for the contact person.
- gender? BePatientContactGender - Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- organization? Reference - Organization on behalf of which the contact is acting or for which the contact is working.
- name? HumanName - A name associated with the contact person.
- telecom? ContactPoint[] - A contact detail for the person, e.g. a telephone number or an email address.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- relationship? CodeableConcept[] - The nature of the relationship between the patient and the contact person.
health.fhir.r4.be.core200: BePatientIdentifierSSIN
Closed record
FHIR BePatientIdentifierSSIN datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BePatientIdentifierUse - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BePatientLink
Closed record
FHIR BePatientLink datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- other Reference - The other patient resource that the link refers to.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type BePatientLinkType - The type of link between this patient resource and another patient resource.
health.fhir.r4.be.core200: BePractitioner
FHIR BePractitioner resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEPRACTITIONER(default RESOURCE_NAME_BEPRACTITIONER) - The type of the resource describes
- identifier? Identifier[] - An identifier that applies to this person in this role. Typically, a NIHDI value and/or a SSIN value are given. Other systems remain allowed. Flows in organizations will most likely want to also include a local identifier, using its own system. A type can be added if needed. When it is given, a consumer SHALL NOT ignore it.
- identifier Slicings
- BePractitionerIdentifierSSIN: An identifier for the person as this agent
- min = 0
- max = *
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
- address? BeAddress[] - An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.
- gender? BePractitionerGender - Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active? boolean - Whether this practitioner's record is in active use. It is RECOMMENDED to keep the value ‘true’ as long as the practitioner is still being treated by the provider of the data.
- photo? Attachment[] - Image of the person.
- language? code - The base language in which the resource is written.
- birthDate? date - The date of birth for the practitioner.
- qualification? BePractitionerQualification[] - The official certifications, training, and licenses that authorize or otherwise pertain to the provision of care by the practitioner. For example, a medical license issued by a medical board authorizing the practitioner to practice medicine within a certian locality.
- contained? Resource[] - 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.
- meta? Meta - 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.
- name HumanName[] - The name(s) associated with the practitioner. Typically RECOMMENDED to include one familyname and at least one given name and to define this use as ‘official’.
- implicitRules? uri - 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.
- telecom? ContactPoint[] - A contact detail for the practitioner, e.g. a telephone number or an email address. It is RECOMMENDED to at least add one phone or email address.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- communication? CodeableConcept[] - A language the practitioner can use in patient communication. It is RECOMMENDED to include this when available
- Element... - Rest field
health.fhir.r4.be.core200: BePractitionerIdentifierCBE
Closed record
FHIR BePractitionerIdentifierCBE datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/cbe") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BePractitionerIdentifierUseOne - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BePractitionerIdentifierNIHDI
Closed record
FHIR BePractitionerIdentifierNIHDI datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/nihdi") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BePractitionerIdentifierUseTwo - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BePractitionerIdentifierSSIN
Closed record
FHIR BePractitionerIdentifierSSIN datatype record.
Fields
- Fields Included from *Identifier
- id string
- extension Extension[]
- use IdentifierUse
- type CodeableConcept
- system uri
- value string
- period Period
- assigner Reference
- Element|Element[]...
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Time period during which identifier is/was valid for use.
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/NamingSystem/ssin") - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- use? BePractitionerIdentifierUse - The purpose of this identifier.
- assigner? Reference - Organization that issued/manages the identifier.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
- value string - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
health.fhir.r4.be.core200: BePractitionerQualification
Closed record
FHIR BePractitionerQualification datatype record.
Fields
- Fields Included from *BackboneElement
- identifier? Identifier[] - An identifier that applies to this person's qualification in this role.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- period? Period - Period during which the qualification is valid.
- code CodeableConcept - Coded representation of the qualification.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- issuer? Reference - Organization that regulates and issues the qualification.
health.fhir.r4.be.core200: BePractitionerRole
FHIR BePractitionerRole resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEPRACTITIONERROLE(default RESOURCE_NAME_BEPRACTITIONERROLE) - The type of the resource describes
- identifier? Identifier[] - Business Identifiers that are specific to a role/location.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
- period? Period - The period during which the person is authorized to act as a practitioner in these role(s) for the organization.
- specialty? CodeableConcept[] - Specific specialty of the practitioner.
- specialty Slicings
- BePractitionerRoleSpecialtySNOMED_CT: Specific specialty of the practitioner
- min = 0
- max = *
- code? CodeableConcept[] - Roles which this practitioner is authorized to perform for the organization. For compatibility reasons, CD-HCPARTY is described here to express the role of the practitioner. Other coding systems remain allowed. Towards the future, the use of SNOMED-CT codes is also RECOMMENDED here. In the future, other ways to codfy might however be also proposed. When available, a provider SHOULD include it. When given, a consumer SHALL record this in its consuming system.
- code Slicings
- BePractitionerRoleCodeCD_HCPARTY: Roles which this practitioner may perform
- min = 0
- max = *
- practitioner? Reference - Practitioner that is able to provide the defined services for the organization.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- active? boolean - Whether this practitioner role record is in active use.
- language? code - The base language in which the resource is written.
- notAvailable? BePractitionerRoleNotAvailable[] - The practitioner is not available or performing this role during this period of time due to the provided reason.
- availableTime? BePractitionerRoleAvailableTime[] - A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.
- contained? Resource[] - 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.
- endpoint? Reference[] - Technical endpoints providing access to services operated for the practitioner with this role.
- healthcareService? Reference[] - The list of healthcare services that this worker provides for this role's Organization/Location(s).
- meta? Meta - 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.
- organization? Reference - The organization where the Practitioner performs the roles associated.
- implicitRules? uri - 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.
- location? Reference[] - The location(s) at which this practitioner provides care.
- telecom? ContactPoint[] - Contact details that are specific to the role/location/service.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- availabilityExceptions? string - A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times.
- Element... - Rest field
health.fhir.r4.be.core200: BePractitionerRoleAvailableTime
Closed record
FHIR BePractitionerRoleAvailableTime datatype record.
Fields
- Fields Included from *BackboneElement
- allDay? boolean - Is this always available? (hence times are irrelevant) e.g. 24 hour service.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- availableEndTime? time - The closing time of day. Note: If the AllDay flag is set, then this time is ignored.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- daysOfWeek? BePractitionerRoleAvailableTimeDaysOfWeek[] - Indicates which days of the week are available between the start and end Times.
- availableStartTime? time - The opening time of day. Note: If the AllDay flag is set, then this time is ignored.
health.fhir.r4.be.core200: BePractitionerRoleCodeCD_HCPARTY
Closed record
FHIR BePractitionerRoleCodeCD_HCPARTY datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? BePractitionerRoleCodeCoding[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.core200: BePractitionerRoleCodeCoding
Closed record
FHIR BePractitionerRoleCodeCoding datatype record.
Fields
- Fields Included from *Coding
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- code code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- system uri(default "https://www.ehealth.fgov.be/standards/fhir/core/CodeSystem/cd-hcparty") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.be.core200: BePractitionerRoleNotAvailable
Closed record
FHIR BePractitionerRoleNotAvailable datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- description string - The reason that can be presented to the user as to why this time is not available.
- during? Period - Service is not available (seasonally or for a public holiday) from this date.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
health.fhir.r4.be.core200: BePractitionerRoleSpecialtyCoding
Closed record
FHIR BePractitionerRoleSpecialtyCoding datatype record.
Fields
- Fields Included from *Coding
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- code code - A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). If needed codes can be used from a different system, SNOMED-CT is preferred.
- system uri(default "http://snomed.info/sct") - The identification of the code system that defines the meaning of the symbol in the code.
- userSelected? boolean - Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
- display? string - A representation of the meaning of the code in the system, following the rules of the system.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'version? string - The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
health.fhir.r4.be.core200: BePractitionerRoleSpecialtySNOMED_CT
Closed record
FHIR BePractitionerRoleSpecialtySNOMED_CT datatype record.
Fields
- Fields Included from *CodeableConcept
- coding? BePractitionerRoleSpecialtyCoding[] - A reference to a code defined by a terminology system.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- text? string - A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
health.fhir.r4.be.core200: BeProvenance
FHIR BeProvenance resource record.
Fields
- Fields Included from *DomainResource
- resourceType RESOURCE_NAME_BEPROVENANCE(default RESOURCE_NAME_BEPROVENANCE) - The type of the resource describes
- reason? CodeableConcept[] - The reason that the activity was taking place.
- agent BeProvenanceAgent[] - An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and 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.
- activity? CodeableConcept - An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities.
- signature? Signature[] - A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- language? code - The base language in which the resource is written.
- occurredPeriod? Period - The period during which the activity occurred.
- recorded instant - The instant of time at which the activity was recorded.
- target Reference[] - The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity.
- contained? Resource[] - 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.
- meta? Meta - 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.
- implicitRules? uri - 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.
- location? Reference - Where the activity occurred, if relevant.
- id? string - The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
- text? Narrative - 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.
- entity? BeProvenanceEntity[] - An entity used in this activity.
- occurredDateTime? dateTime - The period during which the activity occurred.
- policy? uri[] - Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
- Element... - Rest field
health.fhir.r4.be.core200: BeProvenanceAgent
Closed record
FHIR BeProvenanceAgent datatype record.
Fields
- Fields Included from *BackboneElement
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- role? CodeableConcept[] - The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- onBehalfOf? Reference - The individual, device, or organization for whom the change was made.
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- 'type? CodeableConcept - The participation the agent had with respect to the activity.
- who Reference - The individual, device or organization that participated in the event.
health.fhir.r4.be.core200: BeProvenanceEntity
Closed record
FHIR BeProvenanceEntity datatype record.
Fields
- Fields Included from *BackboneElement
- agent? ProvenanceAgent[] - The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity.
- extension? Extension[] - May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and 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.
- role BeProvenanceEntityRole - How the entity was used during the activity.
- what Reference - Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative.
- modifierExtension? Extension[] - 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- id? string - Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Import
import ballerinax/health.fhir.r4.be.core200;Other versions
1.0.0