Purpose
This WS allows to create Composition entity by employees. This service is a single way to create any composition (medical conclusions) exept composition (medical conclusions) about temporary disability and birth. The structure of composition can be variety and depends on configuration of a specific composition type and category (based on configs). The main purpose of this service is to ensure the continuation of the main structure and ensure validation and control of the configuration of a specific composition.
Key points
Only authenticated and authorized employee with appropriate scope can create a Composition.
Request should be signed with DS.
The composition is created asynchronously.
The composition can be created both for persons and for prepersons.
When system validate resource and for current composition type config non exist, system skip validation
All validations using dictionaries apply only to those dictionary values where is_active=true
Specification
Example for Dummy Submit Composition
Type: DRIVERS Category: DRIVERS_GROUP1
Type: DRIVERS Category: DRIVERS_GROUP2
Type: ADOPTION Category: ADOPTER
Type: ADOPTION Category: ADOPTER_RELATIVE
Authorization
Verify the validity of access token
in case of error - return 401 (“Invalid access token”) in case of validation fails
Verify that token is not expired
in case of error - return 401 (“Invalid access token”)
Check user and client scopes in order to perform this action (scope = 'composition:write')
return 403 (“Your scope does not allow to access this resource. Missing allowances: composition:write”) in case of invalid scope(s)
If BLOCK_UNVERIFIED_PARTY_USERS is true, then check party's data match following condition: verification_status != NOT_VERIFIED or (verification_status = NOT_VERIFIED and updated_at > current_date - UNVERIFIED_PARTY_PERIOD_DAYS_ALLOWED):
in case not match - return 403 ("Access denied. Party is not verified")
If BLOCK_DECEASED_PARTY_USERS is true, check that party is not deceased (party_verification record does not equal to: dracs_death_verification_status = VERIFIED and dracs_death_verification_reason = MANUAL_CONFIRMED):
in case of error - return 403 ("Access denied. Party is deceased")
Validate Digital Sign
Validate request is signed
in case of error - return 400 (“Invalid signed content”)
Check DS is valid and not expired
Validate that DS belongs to the employee who sign the Composition ($.attester)
Check that DRFO from DS and party.tax_id of the registrar matches
in case of error - return 422 (“Does not match the signer drfo“)
Validate Patient
Get Patient identifier from the URL
Check it exists in the Mongo DB
Return 404 ('Person is not found') in case of error
Validate request
Validate encoded and decoded request using JSON schema.
Return 422 with the list of validation errors in case validation fails
in case field value does not match the schema - return 422 with field-specific message
in case additional fields exist in request - return 422 (‘schema does not allow additional properties’)
in case required parameter does not exist in request - return 422 (‘required property %{property} was not present’)
in case required amount of parameters does not exist in request - return 422 (‘expected a minimum of %{min} items but got %{actual}’)
Validate composition data using different configs depends on type and category of composition. Return 422 with the list of validation errors in case validation fails.
List of validations for composition depends on type and category. For unique combination of type and category of composition exist only one active config file, if config setting is not exist in file - system must skip validation. Structure of table in DB describe here - https://e-health-ua.atlassian.net/wiki/spaces/EH/pages/18207473689
Find config where composition.type = сonfigurations.type and composition.category = сonfigurations.category and execute validation from config for current composition. Configs for validations stored inprmDB (like forbidden groups). Get file fromprmthen use it in validation composition process.
Config parsing logic:
Workflow:
a. get config by type and category (of composition) from [prm].composition
а.1 in case there is no record in PRM.configurations with requested combination of type and category return 422 - (“Category {{Composition.category}} is not allowed for type {{Composition.type}}”)
b. get setting and compare config.condition data to composition data to find the desired setting (in case when some values isn’t exist - skip validation)
c. compare data from config.check with data from composition
Config contains all variables settings that determine logic and behavior of composition. Structure of config include condition section where describe all condition and check section wich include compared data to composition.
In case when rule from condition or check is not exist, config can have two options:
field from this section isn’t exist, example:
value for section = “any“, example:
Config with condition and check parameters:
condition - this section include all condition which need to compare with current composition data in order to find config object with same values in condition. In case when same values from condition and composition data is not exist - skip validation.
b. check - this section include data which must be checked with composition data. In case when process find same object for config with condition data but data in check section is not the same - system return an error (all errors describe in validations)
Config for sections with array parameters (for example -
COMPOSITION_SECTION_CONFIG) wich used for section structure validation
Parameter | Type | Validation | Description |
|---|---|---|---|
| bool |
| means that section can include other nested sections |
| bool | means that section can be empty (without nested sections or nested entries) | |
| bool | means that section is required for current composition section or required as nested section (on lower level) | |
| bool | means that section must have entry resources | |
| string |
| section code for each set of rules |
| array |
| list of nested section with own rules.Must be filled if |
Return 422 ("Invalid data type for <parameter name>") in case when parameter has different data type
When system validate parameters that relate to the difference between two dates:
difference in the configuration parameter is given in days;
difference is given by the minimum and/or maximum values.
When validating parameters related to the value from dictionaries - configuration parameter indicates not only the code, but also by system.
If there is no settings config for current composition type and category, such validation is skipped and not performed.
Validate Composition
Validate root attributes of composition entity:
1. Status
Composition can be created only in “FINAL” status. Validate status of Composition according to status model - https://e-health-ua.atlassian.net/wiki/spaces/emal/pages/18119950362/NEW+Composition+status+model.
Get status from Composition.status and check (30.1) that status of composition corresponds to appropriate dictionary - COMPOSITION_STATUS
Return 422 ("value is not allowed in enum") in case of error
Get status from Composition.status and check (30.1) that status of composition = FINAL
Return 422 ("value is not allowed in enum") in case of error
2. Type
Get type from Composition.type.coding.code and check (30) that type of composition corresponds to appropriate dictionary - COMPOSITION_TYPES
Return 422 ("value is not allowed in enum") in case of error
Check that Composition.type.coding.code is NOT from COMPOSITION_TYPE_BLACK_LIST
Return 422 ("Composition type is not allowed by configuration") in case of error
3. Category
Get category from Composition.category.coding.code and execute next validations:
Check (30) that value of composition.category is based on COMPOSITION_CATEGORIES dictionary.
Return 422 ("value is not allowed in enum") in case of error
4. Date
Date when employee signed the composition. Get sign date from Composition.date and execute next validations
Check (27) that
composition.date<=composition.event.period.start.Return 422 ("Sign date must be less or equal
composition.event.period.start") in case of error
*next validations use configs
Check (28) the difference between sign date and event.period.start - must be in range of min days and max days (for all items in composition.event). Base on config - COMPOSITION_SIGN_TERM.
Logic: min >=composition.date-composition.event.period.start<= max
or
min >=composition.date-composition.event.period.start(in case when config has only one parameter)Return 422 ("Difference between start date and sign date must be from <min> to <max> days") in case of error
5. Person
Get person id from URL and execute next validations
Validate (8) person verification_status is not equal to NOT_VERIFIED in case when
composition.subject!= preperson.in case NOT_VERIFIED - return error 409 ("Patient is not verified")
Validate (9) person status = active in case when composition.subject type != preperson.
Return 422 ("Patient is not active") in case of error
*next validations use configs
Check (7) possibility to create composition for PREperson - COMPOSITION_PREPERSON_ALLOW.
Return 422 ("Forbidden to create composition with such category for preperson") in case of error
Validate (10) person age between min and max values in config - COMPOSITION_PERSON_AGE.
Skip this validation in case the patient is preperson with an empty age parameter
Calculating logic of person age:
days: from birthday to current date (include leap years)
months: from birthday of month to current days, in result must be integer value of full month
years: from birthday to current day, in result must be integer value of full years
example:
birthday = 12.07.1991, current day = 03.10.1991. Days - 83, month - 2, years - 0
settings value: min - value: 18, units: days and max - value: 1, units: years
calculation logic:
min value 18 days less than 83 days - OK
max value 1 year more than 0 year - OK
birthday = 12.07.1991, current day = 23.05.1995. Days - 1411, month - 46, years - 3
settings value: min - value: 18, units: days and max - value: 1, units: years
calculation logic:
min value 18 days less than 1411 days - OK
max value 3 years more than 1 year - ERROR
Return 422 ("Forbidden to create composition for person of this age") in case of error
Validate (11) person gender must match the config value - COMPOSITION_PERSON_GENDER
Return 422 ("Invalid gender of person for such composition") in case of error
6. Custodian
Get LE identifier from Composition.custodian and execute next validations:
Check (6) that referenced legal_entity with such id exists (is_active = true)
in case of error - return 422 ("LegalEntity with such ID is not found")
Validate (6) that entity status is "ACTIVE" or “SUSPENDED“
in case of error - return 422 ("Legal entity referenced as performer is in invalid status")
Check (21.1) legal_entity_id from token. Check that
composition.custodianid belongs to the LE from token.Return 422 ("Invalid legal entity of employee") in case of error
Check (21.2) legal_entity_id from sign. Check that
composition.custodianid belongs to the LE of user who sign composition.Return 422 ("Invalid legal entity from sign") in case of error
*next validations use configs
Validate (6.1) LE type which base on config - COMPOSITION_LEGAL_ENTITY_TYPE
in case of error - return 422 ("Invalid custodian legal entity type")
Validate (6.2) LE verification status which base on config - COMPOSITION_LEGAL_ENTITY_VERIFICATION_STATUS
in case of error - return 422 ("Invalid legal entity verification status")
7. Encounter
Referenced encounter must have correct status, type and creation date depends on sign composition date. Get encounter data from Composition.encounter and execute next validations:
Check (3) composition.encounter.patient = composition.subject
Return 422 ("Referenced encounter not found for this patient") in case of error
*next validations use configs
Check (2) that referenced encounter in
composition.encounterhas type based on config - COMPOSITION_ENCOUNTER_TYPE.Return 422 ("Forbidden to create composition with selected encounter type") in case of error
Check (4) that referenced encounter in
composition.encounterhas status based on config - COMPOSITION_ENCOUNTER_STATUS.Return 422 ("Forbidden to create composition with selected encounter status") in case of error
Check (5) that difference with create encounter date and sign composition date must be in range of config - COMPOSITION_ENCOUNTER_SIGN_TERM:
min >= composition.encounter.period.start - composition.date <= max
or
min >= composition.encounter.period.start - composition.date (in case when config has only one parameter)Return 422 ("Difference between create encounter date and sign composition date must be in range of <min value> and <max value> days") in case of error
8. Author
Check author type, position, speciality and verify status. Get employee data from Composition.auhtor and execute next validations:
*next validations use configs
Check (12) that author verification status based on config - COMPOSITION_AUTHOR_VERIFICATION_STATUS.
Return 422 ("Employee with such verification status can’t create composition") in case of error
Check (13) that author type based on config - COMPOSITION_AUTHOR_TYPE.
Return 422 ("Forbidden to create composition with selected author type") in case of error
Check (14) that author position based on config - COMPOSITION_AUTHOR_POSITION.
Return 422 ("Forbidden to create composition with selected author position") in case of error
Check (15) that author speciality based on config - COMPOSITION_AUTHOR_SPECIALITY.
Return 422 ("Forbidden to create composition with selected author speciality") in case of error
Check (16) that author main speciality (
employee.accreditation.speciality_officio= true ) based on config - COMPOSITION_AUTHOR_MAIN_SPECIALITY.Return 422 ("Forbidden to create composition with selected author main speciality") in case of error
Check (16.1) that author has combination of allowed specialisation and position from config - COMPOSITION_AUTHOR_SPECIALITY_POSITION
Return 422 ("Forbidden to create composition with selected author speciality and position") in case of error
9. Extension
Check extension from Composition.extension in case when composition event code allow to include extension.
Extension parameters description:
Parameter | Type | M/O | Description |
|---|---|---|---|
code | string | M | Extension code = Validate by config - COMPOSITION_EXTENSION_ALLOW |
valueCodeableConcept | {CodeableConceptExtension} | M |
|
CodeableConceptExtension
Parameter | Type | M/O | Description |
|---|---|---|---|
coding | [Coding] | M |
|
| string | M | Code of additional condition of admission |
| string | M | COMPOSITION_ADDITIONAL_CONDITION_ADMISSION |
text | string | O | Plain text representation of the concept |
extension | [Extension] | O |
|
Extension
Parameter | Type | M/O | Description |
|---|---|---|---|
сode | string | M | Name of object: or letter code of additional condition of admission - COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS |
valueDecimal | number | O | Number value of additional condition of admission. Validation of the need to fill value checked by config - COMPOSITION_ADDITIONAL_CONDITION_VALUES |
valueCodeableConcept | {CodeableConcept} | O |
|
| [Coding] | M |
|
| string | M | Letter code of additional condition of admission. Validation of correctly dependence to the code number by - COMPOSITION_ADDITIONAL_CONDITION_RELATED_LETTER_DESIGNATIONS |
| string | M | COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS |
*next validations use configs
If
composition.extensionis not empty and there is an extension withextension.сode= "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION" validate composition type = “DRIVERS“Return 422 (
COMPOSITION_ADDITIONAL_CONDITION_ADMISSIONextension is not allowed for {{composition_type}} composition type) in case of error
When (36) composition type = “DRIVERS“ and
composition.extensionis not empty, check that at least one ofcomposition.event.codecorresponds to appropriate config - COMPOSITION_EVENT_ADMIT_CODESReturn 422 ("Allow composition status must be Admit when extension is not empty") in case of error
If
composition.extensionis not empty, check thatextension.сodeof extension corresponds to appropriate config - COMPOSITION_EXTENSION_ALLOWReturn 422 ("Prohibited extension code") in case of error
*new validations
If (42.4)
composition.extensionis not empty
ANDextension.сode= “COMPOSITION_ADDITIONAL_CONDITION_ADMISSION“check that value in
extension.valueCodeableConcept.coding.codeis from COMPOSITION_ADDITIONAL_CONDITION_ADMISSION dictionaryReturn 422 ('value is not allowed in enum') in case of error
If (42.5)
composition.extensionis not empty
ANDextension.сode= "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
ANDextension.valueCodeableConcept.extension.valueCodeableConcept.coding.codeis not emptycheck that value is from the COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS dictionary
Return 422 ('value is not allowed in enum') in case of error
If (42.6)
composition.extensionis not empty
ANDextension.сode= "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
ANDextension.valueCodeableConcept.extensionis not empty
ANDextension.valueCodeableConcept.extension.code=COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS
check that:extension.valueCodeableConcept.extension.valueCodeableConcept.coding.codevalue is in configuration.check array, where configuration.condition.code is equal toextension.valueCodeableConcept.coding.code, configuration - ADDITIONAL_CONDITION_RELATED_LETTER_DESIGNATIONSReturn 422 ('Invalid letter designation for the additional admission condition code') in case of error
If
composition.extensionis not empty
ANDextension.сode= "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
ANDextension.value_codeable_concept.extensionis not empty
ANDextension.value_codeable_concept.extension.code= “COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE"
check that:parameter
extension.value_codeable_concept.extension.value_decimalis presentReturn 422 ("
value_decimalmust be present for COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE extension") in case of error
extension.value_codeable_concept.coding.codeis in config.condition array of COMPOSITION_ADDITIONAL_CONDITION_VALUES
AND config.check = falseReturn 422 ('
COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUEextension is not allowed for additional admission condition with code {{extension.value_codeable_concept.coding.code}}') in case of error
there is only one extension in
extension.value_codeable_concept.extensionarray with code =“COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE"Return 422 ("Only one
COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUEextension is allowed for each additional admission condition") in case of error
If (42.7)
composition.extensionis not empty
ANDextension.сode= "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
check config COMPOSITION_ADDITIONAL_CONDITION_VALUES:If
extension.valueCodeableConcept.coding.codeis inconfig.conditionarray
ANDconfig.check= true
THENCheck that
extension.value_codeable_concept.extensionis present andextension.value_codeable_concept.extension.code= “COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE"Return 422 ('Missing required extension
COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUEfor additional admission condition with code {{extension.value_codeable_concept.coding.code}}') in case of error
parameter
extension.value_codeable_concept.extension.value_decimalis present for this additional admission conditionReturn 422 ("
value_decimalmust be present for COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE extension") in case of error
10. Relates to
New composition can replace previously created composition in case when employee add some new information or change patient data. In this case employee fill parameter “relates_to” - reference on previously composition. Get previously created composition identifier from Composition.relates_to and execute next validations:
Check (31) that previously created composition (parameter RelatedArtifact.type = '
replaces') from parametercomposition.relates_toin status "entered_in_error"Return 422 ("Previously created composition must be in status 'entered_in_error'") in case of error
Check (32) that previously created composition (parameter RelatedArtifact.type = '
replaces') from parametercomposition.relates_tonot used for another composition in FINAL status ascomposition.relates_toparameterReturn 422 ("Related composition used for another composition") in case of error
Check (34) type, category and subject of previously created composition(parameter RelatedArtifact.type = '
replaces') from parametercomposition.relates_toand current composition - must be the same:composition.type=relates_to.composition.type
andcomposition.category=relates_to.composition.category
andcomposition.subject=relates_to.composition.subjectReturn 422 ("Type, category and subject of composition and related composition must be the same") in case of error
Check (35) document type of related resource, must be ‘composition’
Return 422 ("Related document type must be 'Composition'") in case of error
*next validations use configs
Check (33) that differenсe from sign date in previously created composition(parameter RelatedArtifact.type = '
replaces') from parametercomposition.relates_toand sign date of current composition between min and max. Base on config - COMPOSITION_CATEGORY_SIGN_DATE_REPLACE:
min >=[old]composition.date (replaces)-[new]composition.date<= max
or
min >=[old]composition.date (replaces)-[new]composition.date(in case when config has only one parameter)Return 422 ("Difference between sign date old and new composition must be from <min> to <max>") in case of error
11. Attester
Check employee data who sign composition. Get employee data from Composition.attester and execute next validations:
Check
composition.Attester.mode.coding.system= "eHealth/composition_attester_modes"
&composition.attester.mode.coding.codeis a value from dictionary eHealth/composition_attester_modesCheck (18) that attester of composition work in same LE as custodian parameter:
сomposition.attesterlegal_entity_id =composition.custodianReturn 422 ("Attester of composition must work in same LE as custodian") in case of error
Check (19) that attester employee is in active status
Return 422 ('Attester is not active') in case of error
Check (19.1) that
composition.attesterarray has only one itemReturn 422 ("Only one attester for composition must be submitted") in case of error
Extract (21) user_id from token. Check that attester belongs to the employee user who sign composition.
Return 422 ('Attester id doesn’t belongs to employee id from token') in case of error
*next validations use configs
Check (20) that attester verification status based on config - COMPOSITION_ATTESTER_VERIFICATION_STATUS.
Return 422 ("Employee with such verification status can’t sign composition") in case of error
Check (17) that author of composition work in same LE with attester:
сomposition.author.legal_entity_id=composition.attester.legal_entity_id. Need validate when "sign_check" value = true - COMPOSITION_ATTESTER_SIGN_CHECK.Return 422 ("Author and Attester of composition must work in same LE as custodian") in case of error
Check (22) that attester type based on config - COMPOSITION_ATTESTER_TYPE.
Return 422 ("Forbidden to create composition with this attester type") in case of error
Check (23) that attester position based on config - COMPOSITION_ATTESTER_POSITION.
Return 422 ("Forbidden to create composition with this attester position") in case of error
Check (24) that attester speciality is in allowed values from config - COMPOSITION_ATTESTER_SPECIALITY.
Return 422 ("Forbidden to create composition with this attester speciality") in case of error
Check (24.1) that attester has combination of allowed specialisation and position from config - COMPOSITION_ATTESTER_SPECIALITY_POSITION
Return 422 ("Forbidden to create composition with selected referenced attester speciality and position") in case of error
Check (26) that attester main speciality (
employee.accreditation.speciality_officio= true ) is in allowed values from config - COMPOSITION_ATTESTER_MAIN_SPECIALITYReturn 422 ("Forbidden to create composition with this attester main speciality") in case of error
12. Event
Check all clinical service(s) being documented. Get events information from Composition.event and execute next validations:
When (39) composition type = “DRIVERS“ and
composition.event.code= "DRIVERS_GROUP1_ADMIT" or "DRIVERS_GROUP2_ADMIT" -composition.event.period.startandcomposition.event.period.endis requiredReturn 422 ("Event period start and period end is required") in case of error
When (40) composition type = “DRIVERS“ and
composition.event.code= "DRIVERS_GROUP1_DENY" or "DRIVERS_GROUP2_DENY" -composition.event.period.startis required andcomposition.event.period.endmust be emptyReturn 422 ("Event period start is required and event period end must be empty") in case of error
When (40.1) composition type = “ADOPTION“ and composition.event.code = "ADOPTION_ADOPTER_INELIGIBLE" or "ADOPTION_ADOPTER_RELATIVE_INELIGIBLE" -
composition.event.period.startis required andcomposition.event.period.endmust be emptyReturn 422 ("Event period start is required and event period end must be empty") in case of error
Check (38.1) all
event.codemust be unique. In case when composition has more than one eventReturn 422 ("Event codes must be unique") in case of error
Check (37.1) that
composition.event.codecorresponds to appropriate dictionary - COMPOSITION_EVENTSReturn 422 ('value is not allowed in enum") in case of error
*next validations use configs
When (25) composition type = “DRIVERS“ check that
event.period(event.period.end-event.period.start) less than duration (depending on person age and compositionevent.code). Base on config - COMPOSITION_EVENT_PERIOD_DURATION
Calculating logic:composition.event.period.end-composition.event.period.start<config.checkvalueReturn 422 ("Composition event period duration must be less than <check.value> <check.units>") in case of error
Check (38) all
composition.event.codein composition - it must corresponds to appropriate config and match with at least one combination of statuses - COMPOSITION_EVENT_CODE
examples:
if composition category = “DRIVERS_GROUP1“ check whatcomposition.event.codemust be:
"DRIVERS_GROUP1_ADMIT"
OR
"DRIVERS_GROUP1_DENY" and “DRIVERS_GROUP2_DENY“if composition category = “DRIVERS_GROUP2“ check that
composition.event.codematch with one of combination:
“DRIVERS_GROUP1_ADMIT“ and “DRIVERS_GROUP2_DENY“
OR
“DRIVERS_GROUP1_ADMIT“ and “DRIVERS_GROUP2_ADMIT“
OR
“DRIVERS_GROUP1_DENY“ and “DRIVERS_GROUP2_DENY“if composition category = “ADOPTERS“ check that
composition.event.codematch with one of combination:
”ELIGIBLE”
OR
”INELIGIBLE”Return 422 ("Invalid event code for current composition category") in case of error
Check (28.1) that
composition.event.period.start<composition.event.period.endReturn 422 ("Period end of event must be later than event start period") in case of error
13. АuthorizeInform with
Validate value in the field $.authorize_withinform_with, string, optional.
Check that authentication method with type = 'THIRD_PERSON' is submitted in $.authorize_with for person (in composition.subject) that must be authorized by confidant person using following logic:persons age < no_self_registration_age global parameter;persons age between no_self_registration_age and person_full_legal_capacity_age global parameters and person does not have document with type from PERSON_LEGAL_CAPACITY_DOCUMENT_TYPES config parameter;persons age > person_full_legal_capacity_age global parameter and exists at least one active and approved confidant person relationship for person (using following process Check confidant person relationship with person_id = person_id from request - expected :ok, :approved response)in case of error - return 422 ('Authentication method with type THIRD_PERSON must be submitted for this person')
Check that $.
authorize_withinform_with is a valid uuidin case error - return 422 ('string does not match pattern') with uuid regexp
Check that authentication method exists in MPI database,
person_authentication_methodstable (with is_active = true), belongs to the same patient as set in the create composition request, is active (ended_at > now() or ended_at is null) and type != NAin case error - return 422 ('Authentication method doesn't exist, is inactive or does not belong to this person')
Get value of
THIRD_PERSON_CONFIDANT_PERSON_RELATIONSHIP_CHECKconfig parameter, if it is set totrue- for authentication method with type = ‘THIRD_PERSON’ check that person from value is an approved confidant for a patient from create composition request – exists active and approved confidant person relationship between person from request and person_id from authentication method value (using following logic: Check confidant person relationship withperson_id= person_id from request andconfidant_person_id= value from auth method - expected:ok, :approvedresponse)in case of error - return 422 ('
Authentication method doesn't exist, is inactive or does not belong to this person''Auth method is not active or confidant person relationship is invalid')
14. Title
Get count of records in ME.requisition_number where requisition_number is equal to Composition.title and entity is equal to “composition” and type is equal to Composition.type.coding[0].code and patient_id = patient_id from the request
if count = 0 Return 422 ("Composition title is invalid
or expired") in case of error
Check there is no Composition with the same title in the DB
in case of error return 422 “Composition with title <title> already exists“
15. Id
Validate value in the field $.id, uuid, required
Check there is no Composition with the same ID in the DB
in case of error return 422 “Composition with title <title> already exists“
Validate Section
Validate $.section parameters in the composition, required. Check all sections - parent and child.
*next validations use configs
Check (43) count of medical records in
composition.section.entry<= then value from config - COMPOSITION_SECTION_ENTRY_LIMIT.Return 422 ("Limit of medical records for this composition type and category must be less or equal <RECORDS_LIMIT>") in case of error
Check (41) codes for all records from
composition.section.entrywhereresource.type= "observation" on prohibited values for composition (all records not include prohibited codes), depends on event codes which included in config - COMPOSITION_SECTION_ENTRY_PROHIBITED_CODES whereconfig.resource_type= "observation"Return 422 ("Prohibited observation code - <code> in section.entry for current composition") in case of error
Check (41.1) codes for all records from
composition.section.entrywhereresource.type= "condition" on prohibited values for composition (all records not include prohibited codes), depends on event codes which included in config - COMPOSITION_SECTION_ENTRY_PROHIBITED_CODES whereconfig.resource_type= "condition"Return 422 ("Prohibited condition code - <code> in section.entry for current composition") in case of error
Check (42) codes for all records from
composition.section.entrywhereresource.type= "observation" on required values for composition (at least one record composition entry must contain) which depends onsection.codewich included in config - COMPOSITION_SECTION_ENTRY_REQUIRED_CODES whereconfig.resource_type= "observation"Return 422 ("Empty required codes in section.entry for current composition") in case of error
Check (42.1) codes for all records from
composition.section.entrywhereresource.type= "condition" on required values for composition (at least one record composition entry must contain) which depends onsection.codewich included in config - COMPOSITION_SECTION_ENTRY_REQUIRED_CODES whereconfig.resource_type= "condition"Return 422 ("Empty required codes in section entry for current composition") in case of error
Check (44 + 45) existing in composition required and optional sections codes which depends on
section.code- COMPOSITION_SECTION_CONFIG
Logic description:
Find allconfig.codewhere parameterconfig.mandatory= true and compare all codes tocomposition.section.[n].code. In case when config has nested sections but parametermandatory= false - don't compare codes to nested sections.
Logic description:in case when object from
configorconfig.sections.[n]havemandatory= true butcomposition.section.codeorcomposition.section.section.[n].codehasn’t same value inconfig.codeorconfig.sections.[n].code- return errorin case when
composition.section.codehas code wich hasn’tconfig.code- return errorReturn 422 ("Invalid section content. Mandatory section
{{code}}is missed") in case of error with empty required fields
Check (45.1) section codes for nested sections hierarchy from config which depends on config - COMPOSITION_SECTION_CONFIG
Logic description:
Check that all values fromcomposition.section.codeequal toconfig.codefromconfig.sectionson the same nested level whereconfig.sectionAllowed= truein case when value from
composition.section.codehasn’t same values with nestedconfig.code(fromconfig.sections) orcomposition.section.codehas codes wich doesn’t exist inconfig.code(fromconfig.sections) - return error Return 422 ("Invalid section hierarchy for nested section") in case of error with empty required fields
examples
success case:
Composition -composition.section.code= MAIN, nested section -composition.section.section.code= PEDIATRIST
Config -config.sectionAllowed= true,config.code= MAIN,config.section.code= PEDIATRIST
error case 1:
Composition -composition.section.code= MAIN, nested section -composition.section.section.code= NURSING
Config -config.sectionAllowed= true,config.code= MAIN,config.section.code= PEDIATRIST
error case 2:
Composition -composition.section.code= MAIN, nested section -composition.section.section.code= PEDIATRIST
Config -config.sectionAllowed= true,config.code= MAIN,config.section.code= PEDIATRIST +config.section.code= MAINCheck (45.2) section content for all sections which depends on section code - COMPOSITION_SECTION_CONFIG
Configuration parameters description:
if
sectionAllowed= true current section can contain nested sectionsif
isEmpty= true current section can contain emptyReason parameter instead ofentryarrayif
containsResources= true current section can containentryandorderByparameters
Validate section content:
Check that current section contains just one of:
nested
sectionparameteremptyReasonparameterentryparameterin case of error an error return 422 ("Section {{section_code}} must contain one AND only one of: nested
section,emptyReasonorentry")
In case section contains
entryparameter check thatcontainsResources= truein case
containsResources= false return 422 ("Section {{section_code}} can not containentry")
In case section contains emptyReason check that
isEmpty= truein case
isEmpty= false return 422 ("Section {{section_code}} can not contain emptyReason")
In case section contains nested
sectioncheck thatsectionAllowed= truein case
sectionAllowed= false return 422 ("Section {{section_code}} can not contain nestedsection")
Check (46) nesting level of sections <= the allowed limit - COMPOSITION_SECTION_NESTING_LEVEL
Return 422 ("Prohibited nested level for composition section") in case of error
Check (47) count of section <= than value from - COMPOSITION_SECTION_COUNT_LIMIT
Return 422 ("Prohibited amount of composition section") in case of error
Validate section content
Section have child sections so we need to execute all validations for $.section.section parameters for each sections
Validate section content
Check (53) that person status in
composition.section.author<> not verifiedReturn 422 ("Status of person can’t be 'not verified' in
composition.section.author") in case of error
*next validations use configs
Check (48) composition.section.title
Check that composition.section.title is not empty.
Also check value from COMPOSITION_SECTION_TITLE_MANUAL_FILL config (depends on
composition.section.code)if config.value = "true" (or section with same code doesn't exist) - don’t validate
composition.section.titleelse if value = "false"
get display value from COMPOSITION_SECTION_CODES dictionary where key=
composition.section.codecheck
composition.section.title= display
Return 422 ("Invalid title for composition.section") in case of error
Check (48.1) that section code (
composition.section.code) corresponds to appropriate dictionary - COMPOSITION_SECTION_CODESReturn 422 ("Section code value is not allowed in enum") in case of error
Check (48.2) that section order by parameter (
composition.section.orderby) corresponds to appropriate dictionary - COMPOSITION_SECTION_ORDERBYReturn 422 ("Section order by value is not allowed in enum") in case of error
Check (48.3) that empty reason (
composition.section.emptyreason) corresponds to appropriate config - COMPOSITION_SECTION_EMPTY_REASON. In case whencomposition.section.emptyreasonis not emptyReturn 422 ("Empty reason value is not allowed in enum") in case of error
Check (50) that person from all records in
composition.section.entrythe same ascomposition.subject(or merged person inmpi.merged_person)Return 422 ("Person from section.entry must be the same as composition.subject or composition.section.focus") in case of error
Check (54) that author position from
section.authorbased on config - COMPOSITION_SECTION_AUTHOR_POSITION for selectedsection.codeReturn 422 ("Section author position does not allow") in case of error
Check (55) that author speciality from
section.authorbased on config - COMPOSITION_SECTION_AUTHOR_SPECIALITY for selectedsection.codeReturn 422 ("Section author speciality does not allow to create such composition") in case of error
Check (55.1) that author main speciality (
employee.accreditation.speciality_officio= true ) fromsection.authorbased on based on config - COMPOSITION_SECTION_AUTHOR_MAIN_SPECIALITYReturn 422 ("Section author main speciality does not allow to create such composition") in case of error
Check (56) count of resources from
composition.section.entryselectedsection.code- COMPOSITION_SECTION_SECTION_ENTRY_LIMITReturn 422 ("Max count of resources in
section.entry- <count>") in case of error
Check (56.1) that the resource type of the resource in
composition.section.entryis allowed by config COMPOSITION_SECTION_SECTION_ENTRY_RESOURCES for thissection.codeandevent.codeReturn 422 ("Resource type is not allowed in this section for this event code") in case of error
Referenced resources validations
Get referenced resources from section.entry and check data. If entry section is not empty - execute validations depends on resource type.
Referenced episode of care
Validate resources where ResourceType = “episodes”
*next validations use configs
Check (57) that referenced episode (if entry has resource with this type) from
composition.section.entryhas type based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TYPEReturn 422 ("Invalid referenced episode type in section.entry") in case of error
Check (58) that referenced episode (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced episode status in section.entry") in case of error
Check (59) that different from sign composition date and referenced episode (if entry has resource with this type)
period.startincomposition.section.entrybetween min and max (depending on Composition type, category and section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_START:
min >=composition.date-episode.period.start<= max
or
min >=composition.date-period.start(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced episode start date must be from <min> to <max>") in case of error
Referenced diagnostic report
Validate resources where ResourceType = “diagnostic_reports”
*next validations use configs
Check (60) that referenced diagnostic report (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced diagnostic report status in section.entry") in case of error
Check (61) that referenced diagnostic report (if entry has resource with this type) from
composition.section.entryhas code based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE where resource_type = "diagnostic report"Return 422 ("Invalid code in referenced diagnostic report at section.entry") in case of error
Check (62) that referenced diagnostic report (if entry has resource with this type) from
composition.section.entryhas category based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORYReturn 422 ("Invalid category in referenced diagnostic report at section.entry") in case of error
Check (63) that different from sign composition date and referenced diagnostic report (if entry has resource with this type)
effective_period.endincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_END:
min >=composition.date-diagnostic_report.effective_period.end<= max
or
min >=composition.date-diagnostic_report.effective_period.end(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced diagnostic report end date must be from <min> to <max>") in case of error
Check (63.1) that different from sign composition date and referenced diagnostic report (if entry has resource with this type)
issuedincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CREATED_AT:
min >=composition.date-diagnostic_report.issued<= max
or
min >=composition.date-diagnostic_report.issued(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced diagnostic report issued date must be from <min> to <max>") in case of error
Referenced encounter
Validate resources where ResourceType = “encounters”
*next validations use configs
Check (64) that referenced encounter (if entry has resource with this type) from
composition.section.entryhas type based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TYPE whereresource_type= "encounter"Return 422 ("Invalid referenced encounter type in section.entry") in case of error
Check (65) that referenced encounter (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced encounter status in section.entry") in case of error
Check (66) that referenced encounter (if entry has resource with this type) from
composition.section.entryhas class (class.coding.code and class.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_ENCOUNTER_CLASSReturn 422 ("Invalid referenced encounter class in section.entry") in case of error
Check (67) that different from sign composition date and referenced encounter (if entry has resource with this type)
period.endordate(depending on which parameter is filled) incomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_END:
min >=composition.date-encounter.period.endorencounter.date<= max
or
min >=composition.date-encounter.period.endorencounter.date(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced encounter (in section.entry) end date must be from <min> to <max>") in case of error
Referenced care plan
Validate resources where ResourceType = “care_plans”
*next validations use configs
Check (67.1) that referenced care plan (if entry has resource with this type) from
composition.section.entryhas category based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORYReturn 422 ("Invalid category in referenced care plan at section.entry") in case of error
Check (68) that referenced care plan (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced care plan status in section.entry") in case of error
Check (70) that different from sign composition date and referenced care plan (if entry has resource with this type)
period.startincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_START:
min >=composition.date-care_plan.period.start<= max
or
min >=composition.date-care_plan.period.start(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced care plan start date must be from <min> to <max>") in case of error
Referenced activities
Validate resources where ResourceType = “activities”
*next validations use configs
Check (71) that referenced activity (if entry has resource with this type) from
composition.section.entryhas detail.kind based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_ACTIVITY_DETAIL_KINDReturn 422 ("Invalid referenced activity detail.kind in section.entry") in case of error
Check (72) that referenced activity (if entry has resource with this type) from
composition.section.entryhas detail.product_reference (care_plan) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_ACTIVITY_DETAIL_PRODUCT_REFERENCEReturn 422 ("Invalid referenced activity detail.product_reference in section.entry") in case of error
Check (73) that referenced activity (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced activity status in section.entry") in case of error
Referenced procedure
Validate resources where ResourceType = “procedures”
*next validations use configs
Check (74) that referenced procedure (if entry has resource with this type) from
composition.section.entryhas code (code.identifier.type.coding.code and code.identifier.type.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TYPEReturn 422 ("Invalid referenced procedure type in section.entry") in case of error
Check (75) that referenced procedure (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced procedure status in section.entry") in case of error
Check (76) that different from sign composition date and referenced procedure (if entry has resource with this type) between min and max (depends on section code):
if procedure has filledperformed_period.endincomposition.section.entrycalculate:
min >=composition.date-procedure.performed_period.end<= max
or
min >=composition.date-procedure.performed_period.end(in case when config has only one parameter)
Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_END whereresource_type= "procedure"
if procedure has filledperformed_date_timeincomposition.section.entrycalculate:
min >=composition.date-procedure.performed_date_time<= max
or
min >=composition.date-procedure.performed_date_time(in case when config has only one parameter)
Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "procedure" andaction= "performed"Return 422 ("Difference between sign composition date and referenced procedure date must be from <min> to <max>") in case of error
Referenced condition
Validate resources where ResourceType = “conditions”
*next validations use configs
Check (77) that referenced condition (if entry has resource with this type) from
composition.section.entryhas code (at least one item in code.coding array (code.coding.code and code.coding.system)) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE whereresource_type= "condition"Return 422 ("Invalid referenced condition code.coding in section.entry") in case of error
Check (78) that referenced condition (if entry has resource with this type) from
composition.section.entryhas clinical_status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced condition clinical_status in section.entry") in case of error
Check (79) that referenced condition (if entry has resource with this type) from
composition.section.entryhas verification_status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_CONDITION_VERIFICATION_STATUSReturn 422 ("Invalid referenced condition verification_status in section.entry") in case of error
Check (80) that different from sign composition date and referenced condition (if entry has resource with this type)
asserted_dateincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "condition" andaction= "asserted":
min >=composition.date-condition.asserted_date<= max
or
min >=composition.date-condition.asserted_date(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced condition asserted date must be from <min> to <max>") in case of error
Check (81) that different from sign composition date and referenced condition (if entry has resource with this type)
onset_dateincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "condition" andaction= "onset":
min >=composition.date-condition.onset_date<= max
or
min >=composition.date-condition.onset_date(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced condition onset date must be from <min> to <max>") in case of error
Referenced observation
Validate resources where ResourceType = “observations”
*next validations use configs
Check (82) that referenced observation (if entry has resource with this type) from
composition.section.entryhas code (code.coding.code and code.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE whereresource_type= "observation"Return 422 ("Invalid code in referenced observation at section.entry") in case of error
Check (83) that referenced observation (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced observation status in section.entry") in case of error
Check (84) that referenced observation (if entry has resource with this type) from
composition.section.entryhas category based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORYReturn 422 ("Invalid category in referenced observation at section.entry") in case of error
Check (85) that different from sign composition date and referenced observation (if entry has resource with this type)
issuedincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "observation" andaction= "issued":
min >=composition.date-observation.issued<= max
or
min >=composition.date-observation.issued(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced observation issued date must be from <min> to <max>") in case of error
Return 422 ("Invalid referenced observation date in section.entry") in case of error
Check (86) that different from sign composition date and referenced observation (if entry has resource with this type) between min and max (depends on section code):
if observation has filledeffective_period.endincomposition.section.entrycalculate:
min >=composition.date-observation.effective_period.end<= max
or
min >=composition.date-observation.effective_period.end(in case when config has only one parameter)
Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_END whereresource_type= "observation"
if observation has filledeffective_date_timeincomposition.section.entrycalculate:
min >=composition.date-observation.effective_date_time<= max
or
min >=composition.date-observation.effective_date_time(in case when config has only one parameter)
Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "observation" andaction= "effective"Return 422 ("Difference between sign composition date and referenced observation date must be from <min> to <max>") in case of error
Referenced immunization
Validate resources where ResourceType = “immunizations”
*next validations use configs
Check (90) that referenced immunization (if entry has resource with this type) from
composition.section.entryhas explanation.reason_not_given (explanattion.reason_not_given.coding.code and explanation.reason_not_given.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_IMMUNIZATION_EXPLANATION_REASON_NOT_GIVENReturn 422 ("Invalid referenced immunization explanation reason not given in section.entry") in case of error
Check (91) that referenced immunization (if entry has resource with this type) from
composition.section.entryhas explanation.reason (explanattion.reason.coding.code and explanation.reason.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_IMMUNIZATION_EXPLANATION_REASONReturn 422 ("Invalid referenced immunization explanation reason in section.entry") in case of error
Check (92) that referenced immunization (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced immunization status in section.entry") in case of error
Check (93) that referenced immunization (if entry has resource with this type) from
composition.section.entryhas vaccine_code (vaccine_code.coding.code and vaccine_code.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE whereresource_type= "immunization"Return 422 ("Invalid vaccine code in referenced immunization at section.entry") in case of error
Check (94) that referenced immunization (if entry has resource with this type) from
composition.section.entryhas report_origin (report_origin.coding.code and report_origin.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_IMMUNIZATION_REPORT_ORIGINReturn 422 ("Invalid referenced immunization report origin in section.entry") in case of error
Check (95) that different from sign composition date and referenced immunization (if entry has resource with this type)
dateincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "immunization" andaction= "date":
min >=composition.date-immunization.date<= max
or
min >=composition.date-immunization.date(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced immunization date must be from <min> to <max>") in case of error
Referenced medication request
Validate resources where ResourceType = “medical_requests”
*next validations use configs
Check (96) that referenced medication request (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced medication request status in section.entry") in case of error
Check (97) that different from sign composition date and referenced medication request (if entry has resource with this type)
created_atincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "medication request" andaction= "created":
min >=composition.date-medication_request.created_at<= max
or
min >=composition.date-medication_request.created_at(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced medication request created date must be from <min> to <max>") in case of error
Check (98) that different from sign composition date and referenced medication request (if entry has resource with this type)
started_atincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_START:
min >=composition.date-medication_request.started_at<= max
or
min >=composition.date-medication_request.started_at(in case when config has only one parameter)Return 422 ("Difference between sign composition date and referenced medication request started at date must be from <min> to <max>") in case of error
Referenced service request
Validate resources where ResourceType = “service_requests”
*next validations use configs
Check (100) that referenced service request (if entry has resource with this type) from
composition.section.entryhas category (category.coding.code and category.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORYReturn 422 ("Invalid category in referenced service request at section.entry")
Check (101) that referenced service request (if entry has resource with this type) from
composition.section.entryhas code.identifier (code.identifier.type.coding.code and code.identifier.type.coding.system) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE whereresource_type= "service request"Return 422 ("Invalid code identifier in referenced service request at section.entry") in case of error
Check (102) that referenced service request (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced service request status in section.entry") in case of error
Check (103) that different from sign composition date and referenced service request (if entry has resource with this type) between min and max (depends on section code):
if service request has filledoccurrence_period.startincomposition.section.entrycalculate:
min >=composition.date-service_request.occurrence_period.start<= max
or
min >=composition.date-service_request.occurrence_period.start(in case when config has only one parameter)
Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_PERIOD_START whereresource_type= "service request"
if service request has filledoccurrence_date_timeincomposition.section.entrycalculate:
min >=composition.date-service_request.occurrence_date_time<= max
or
min >=composition.date-service_request.occurrence_date_time(in case when config has only one parameter)
Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM whereresource_type= "service request" andaction= "occurrence"Return 422 ("Difference between sign composition date and referenced service request date must be from <min> to <max>") in case of error
Referenced division
Validate resources where ResourceType = “divisions”
*next validations use configs
Check (120) that referenced division (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUSReturn 422 ("Invalid referenced division status in section.entry") in case of error
Check (121) that referenced division (if entry has resource with this type) from
composition.section.entryhas type based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TYPEReturn 422 ("Invalid referenced division type in section.entry") in case of error
Referenced employee
Validate resources where ResourceType = “employees”
*next validations use configs
Check (122) that referenced employee (if entry has resource with this type) from
composition.section.entryhas status based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_EMPLOYEE_STATUSReturn 422 ("Invalid referenced employee status in section.entry") in case of error
Check (123) that referenced employee (if entry has resource with this type) from
composition.section.entryhas position based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_EMPLOYEE_POSITIONReturn 422 ("Invalid referenced employee position in section.entry") in case of error
Check (124) that referenced employee (if entry has resource with this type) from
composition.section.entryhas speciality based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_EMPLOYEE_SPECIALITYReturn 422 ("Invalid referenced employee speciality in section.entry") in case of error
Check (124.1) that referenced employee (if entry has resource with this type) from
composition.section.entryhas main speciality (employee.accreditation.speciality_officio= true ) based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_EMPLOYEE_MAIN_SPECIALITYReturn 422 ("Invalid referenced employee main speciality in section.entry") in case of error
Check (125) that referenced employee (if entry has resource with this type) from
composition.section.entryhas type based on dictionary which depends onsection.code- COMPOSITION_SECTION_SECTION_ENTRY_EMPLOYEE_TYPEReturn 422 ("Invalid referenced employee type in section.entry") in case of error
Check (126) that different from sign composition date and referenced employee (if entry has resource with this type) start working date -
start_dateincomposition.section.entrybetween min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_DEVICE_DISPENSE_WHEN_HANDED_OVER:
min >=composition.date-employee.start_date<= max
or
min >=composition.date-employee.start_date(in case when config has only one parameter)Return 422 ("Difference between sign composition date and employee start working date must be from <min> to <max>") in case of error
Service logic
Save signed content to media storage, in the bucket pointed in MEDIA_STORAGE_COMPOSITION_BUCKET chart parameter
Set subject with hashed mpi identifier from URL
Get encounter where id = Composition.encounter.identifier.value
Set Composition.context_episode_id = encounter.episode
Save data to compositions collection in DB according to composition data model
Save link from media storage to the $.signed_content_links field in compositions collection
Create job and return it’s id.
If $.authorize_with is submitted send SMS to patient with composition number via template
CREATE_{{COMPOSITION_TYPE}}_COMPOSITION_SMS_TEMPLATE. Use $.authorize_with as patient’s authentication method