Versions Compared

Old Version 7

changes.mady.by.user Kateryna Haleta (SoE eHealth)

Saved on

compared with

New Version 8

changes.mady.by.user Kateryna Haleta (SoE eHealth)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

...

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

...

  1. 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

  2. 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:

  1. 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

  1. 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

  1. Return 422 ("Forbidden to create composition for person of this age") in case of error

  2. 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:

...

  1. Validate (6.1) LE type which base on config - COMPOSITION_LEGAL_ENTITY_TYPE

    • in case of error - return 422 ("Invalid custodian legal entity type")

  2. 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")

...

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 = COMPOSITION_ADDITIONAL_CONDITION_ADMISSION

Validate by config - COMPOSITION_EXTENSION_ALLOW

valueCodeableConcept

{CodeableConceptExtension}

M

 

CodeableConceptExtension

Parameter

Type

M/O

Description

coding

[Coding]

M

 

  • code

string

M

Code of additional condition of admission

  • system

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:
Number value of additional condition of admission -COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE

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

[Coding]

M

 

  • code

string

M

Letter code of additional condition of admission.

Validation of correctly dependence to the code number by - COMPOSITION_ADDITIONAL_CONDITION_RELATED_LETTER_DESIGNATIONS

  • system

string

M

COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS

 

*next validations use configs

  1. If composition.extension is not empty and there is an extension with extension.сode = "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION" validate composition type = “DRIVERS“

    1. Return 422 (COMPOSITION_ADDITIONAL_CONDITION_ADMISSION extension is not allowed for {{composition_type}} composition type) in case of error

  2. When (36) composition type = “DRIVERS“ and composition.extension is not empty, check that at least one of composition.event.code corresponds to appropriate config - COMPOSITION_EVENT_ADMIT_CODES

  3. Return 422 ("Allow composition status must be Admit when extension is not empty") in case of error

  4. If composition.extension is not empty, check that extension.сode of extension corresponds to appropriate config - COMPOSITION_EXTENSION_ALLOW

    • Return 422 ("Prohibited extension code") in case of error

*new validations

  1. If (42.4) composition.extension is not empty
    AND
    extension.сode = “COMPOSITION_ADDITIONAL_CONDITION_ADMISSION“

    1. check that value in extension.valueCodeableConcept.coding.code is from COMPOSITION_ADDITIONAL_CONDITION_ADMISSION dictionary

      1. Return 422 ('value is not allowed in enum') in case of error

  2. If (42.5) composition.extension is not empty
    AND
    extension.сode = "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
    AND
    extension.valueCodeableConcept.extension.valueCodeableConcept.coding.code is not empty

    1. check that value is from the COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS dictionary

      1. Return 422 ('value is not allowed in enum') in case of error

  3. If (42.6) composition.extension is not empty
    AND extension.сode = "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
    AND extension.valueCodeableConcept.extension is not empty
    AND extension.valueCodeableConcept.extension.code = COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_LETTER_DESIGNATIONS
    check that:

    1. extension.valueCodeableConcept.extension.valueCodeableConcept.coding.code value is in configuration.check array, where configuration.condition.code is equal to extension.valueCodeableConcept.coding.code, configuration - ADDITIONAL_CONDITION_RELATED_LETTER_DESIGNATIONS

      1. Return 422 ('Invalid letter designation for the additional admission condition code') in case of error

  4. If composition.extension is not empty
    AND extension.сode = "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
    AND extension.value_codeable_concept.extension is not empty
    AND extension.value_codeable_concept.extension.code = “COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE"
    check that:

    1. parameter extension.value_codeable_concept.extension.value_decimal is present

      1. Return 422 ("value_decimal must be present for COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE extension") in case of error

    2. extension.value_codeable_concept.coding.code is in config.condition array of COMPOSITION_ADDITIONAL_CONDITION_VALUES
      AND config.check = false

      1. Return 422 ('COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE extension is not allowed for additional admission condition with code {{extension.value_codeable_concept.coding.code}}') in case of error

    3. there is only one extension in extension.value_codeable_concept.extension array with code =“COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE"

      1. Return 422 ("Only one COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE extension is allowed for each additional admission condition") in case of error

  5. If (42.7) composition.extension is not empty
    AND extension.сode = "COMPOSITION_ADDITIONAL_CONDITION_ADMISSION"
    check config COMPOSITION_ADDITIONAL_CONDITION_VALUES:

    1. If extension.valueCodeableConcept.coding.code is in config.condition array
      AND config.check = true
      THEN

      1. Check that extension.value_codeable_concept.extension is present and extension.value_codeable_concept.extension.code = “COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE"

        1. Return 422 ('Missing required extension COMPOSITION_ADDITIONAL_CONDITION_ADMISSION_VALUE for additional admission condition with code {{extension.value_codeable_concept.coding.code}}') in case of error

      2. parameter extension.value_codeable_concept.extension.value_decimal is present for this additional admission condition

        1. Return 422 ("value_decimal must 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 employee data who sign composition. Get employee data from Composition.attester and execute next validations:

  1. Check composition.Attester.mode.coding.system = "eHealth/composition_attester_modes"
    & composition.attester.mode.coding.code is a value from dictionary eHealth/composition_attester_modes

  2. Check (18) that attester of composition work in same LE as custodian parameter: сomposition.attester legal_entity_id = composition.custodian

    • Return 422 ("Attester of composition must work in same LE as custodian") in case of error

  3. Check (19) that attester employee is in active status

    • Return 422 ('Attester is not active') in case of error

  4. Check (19.1) that composition.attester array has only one item

    • Return 422 ("Only one attester for composition must be submitted") in case of error

  5. 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

...

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

  6. 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

  7. Check (26) that attester main speciality (employee.accreditation.speciality_officio = true ) is in allowed values from config - COMPOSITION_ATTESTER_MAIN_SPECIALITY

    • Return 422 ("Forbidden to create composition with this attester main speciality") in case of error

...

  1. When (39) composition type = “DRIVERS“ and composition.event.code = "DRIVERS_GROUP1_ADMIT" or "DRIVERS_GROUP2_ADMIT" - composition.event.period.start and composition.event.period.end is required

    • Return 422 ("Event period start and period end is required") in case of error

  2. When (40) composition type = “DRIVERS“ and composition.event.code = "DRIVERS_GROUP1_DENY" or "DRIVERS_GROUP2_DENY" - composition.event.period.start is required and composition.event.period.end must be empty

    • Return 422 ("Event period start is required and event period end must be empty") in case of error

  3. When (40.1) composition type = “ADOPTION“ and composition.event.code = "ADOPTION_ADOPTER_INELIGIBLE" or "ADOPTION_ADOPTER_RELATIVE_INELIGIBLE" - composition.event.period.start is required and composition.event.period.end must be empty

    Return 422 ("Event period start is required and event period end must be empty") in case of error

  4. Check (38.1) all event.code must be unique. In case when composition has more than one event

    • Return 422 ("Event codes must be unique") in case of error

  5. Check (37.1) that composition.event.code corresponds to appropriate dictionary - COMPOSITION_EVENTS

    • Return 422 ('value is not allowed in enum") in case of error

*next validations use configs

  1. When (25) composition type = “DRIVERS“ check that event.period (event.period.end - event.period.start) less than duration (depending on person age and composition event.code). Base on config - COMPOSITION_EVENT_PERIOD_DURATION
    Calculating logic:
    composition.event.period.end - composition.event.period.start < config.check value

    • Return 422 ("Composition event period duration must be less than <check.value> <check.units>") in case of error

  2. Check (38) all composition.event.code in 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 what composition.event.code must be:
    "DRIVERS_GROUP1_ADMIT"
    OR
    "DRIVERS_GROUP1_DENY" and “DRIVERS_GROUP2_DENY“

    if composition category = “DRIVERS_GROUP2“ check that composition.event.code match 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.code match with one of combination:
    ”ELIGIBLE”
    OR
    ”INELIGIBLE”

    • Return 422 ("Invalid event code for current composition category") in case of error

  3. Check (28.1) that composition.event.period.start < composition.event.period.end

    • Return 422 ("Period end of event must be later than event start period") in case of error

13.

...

Inform with

Validate value in the field $.authorizeinform_with, string, optional.

  • Check that authentication method with type = ‘THIRD'THIRD_PERSON’ PERSON' is submitted in $.authorize_with for person (in composition.subject) that must be authorized by confidant person using following logic:

    1. persons age < no< no_self_registration_age global age global parameter;

    2. persons age between no_self_registration_age and personand person_full_legal_capacity_age global age global parameters and person does not have document with type from PERSONfrom PERSON_LEGAL_CAPACITY_DOCUMENT_TYPES config TYPES config parameter;

    3. 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)

      1. in case of error - return 422 ('Authentication method with type THIRD_PERSON must be submitted for this person')

  • Check that $.authorizeinform_with is a valid uuid

    • in case error - return 422 ('string does not match pattern') with uuid regexp

  • Check that authentication method exists in MPI database, person_authentication_methods table (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 != NA

    • in 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_CHECK config parameter, if it is set to true - 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 with person_id = person_id from request and confidant_person_id = value from auth method - expected :ok, :approved response)

    1. 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

  1. 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

    1. if count = 0 Return 422 ("Composition title is invalid or expired") in case of error

  2. Check there is no Composition with the same title in the DB

    • in case of error return 422 “Composition with title <title> already exists“

...

  1. 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

  2. Check (41) codes for all records from composition.section.entry where resource.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 where config.resource_type = "observation"

    • Return 422 ("Prohibited observation code - <code> in section.entry for current composition") in case of error

  3. Check (41.1) codes for all records from composition.section.entry where resource.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 where config.resource_type = "condition"

    • Return 422 ("Prohibited condition code - <code> in section.entry for current composition") in case of error

  4. Check (42) codes for all records from composition.section.entry where resource.type = "observation" on required values for composition (at least one record composition entry must contain) which depends on section.code wich included in config - COMPOSITION_SECTION_ENTRY_REQUIRED_CODES where config.resource_type = "observation"

    • Return 422 ("Empty required codes in section.entry for current composition") in case of error

  5. Check (42.1) codes for all records from composition.section.entrywhere resource.type = "condition" on required values for composition (at least one record composition entry must contain) which depends on section.code wich included in config - COMPOSITION_SECTION_ENTRY_REQUIRED_CODES where config.resource_type = "condition"

    • Return 422 ("Empty required codes in section entry for current composition") in case of error

  6. Check (44 + 45) existing in composition required and optional sections codes which depends on section.code - COMPOSITION_SECTION_CONFIG
    Logic description:
    Find all config.code where parameter config.mandatory = true and compare all codes to composition.section.[n].code. In case when config has nested sections but parameter mandatory = false - don't compare codes to nested sections.
    Logic description:

    • in case when object from config or config.sections.[n] have mandatory = true but composition.section.code or composition.section.section.[n].code hasn’t same value in config.code or config.sections.[n].code - return error

    • in case when composition.section.code has code wich hasn’t config.code - return error

    • Return 422 ("Invalid section content. Mandatory section {{code}} is missed") in case of error with empty required fields

  7. Check (45.1) section codes for nested sections hierarchy from config which depends on config - COMPOSITION_SECTION_CONFIG
    Logic description:
    Check that all values from composition.section.code equal to config.code from config.sections on the same nested level where config.sectionAllowed = true

    • in case when value from composition.section.code hasn’t same values with nested config.code (from config.sections) or composition.section.code has codes wich doesn’t exist in config.code (from config.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 = MAIN

  8. Check (45.2) section content for all sections which depends on section code - COMPOSITION_SECTION_CONFIG

    1. Configuration parameters description:

      • if sectionAllowed = true current section can contain nested sections

      • if isEmpty = true current section can contain emptyReason parameter instead of entry array

      • if containsResources = true current section can contain entry and orderBy parameters

      Validate section content:

    2. Check that current section contains at least one of:

      1. nested section parameter

      2. emptyReason parameter

      3. entry parameter

      4. in case of error an error return 422 ("Section {{section_code}} must contain at least one of: nested section, emptyReason or entry")

      3. In case section contains entry parameter check that containsResources = true

      in case containsResources = false return 422 ("Section {{

      • section

      _code}}

      • can

      not

      • contain

      entry")In case section contains emptyReason check that

      • nested sections

      • if isEmpty = true

      1. in case isEmpty = false return 422 ("Section {{section_code}} can not contain emptyReason")

    3. In case section contains nested section check that sectionAllowed = true

      1. in case sectionAllowed = false return 422 ("Section {{section_code}} can not contain nested section")

      4.  In case section containsentry parameter AND emptyReason parameter

      • current section can contain emptyReason parameter instead of entry array

      • if containsResources = true current section can contain entry and orderBy parameters

    4. Validate section content:

      1. Check that current section contains just one of:

        1. nested section parameter

        2. emptyReason parameter

        3. entry parameter

        4. in case of error an error return 422 ("Section {{section_code}} can not contain both entry and emptyReason parametersmust contain one AND only one of: nested section, emptyReason or entry")

      2. In case configuration parameters containsResources = true and isEmpty = true check that one of parameters is present: entry or emptyReason, and entry array is not empty

        in case of error an error

        section contains entry parameter check that containsResources = true

        1. in case containsResources = false return 422 ("Section {{section_code}} must can not contain one of: entry or emptyReason parameters")

      3. in case of error an error

        In case one of configuration parameters: containsResources or isEmpty is true:

        containsResources= true, isEmpty=false check that entry array is not empty

        section contains emptyReason check that isEmpty = true

        1. in case isEmpty = false return 422 ("Section {{section_code}}

          must contain entry array with resources

          can not contain emptyReason")

          containsResources= false, isEmpty=true check that emptyReason is not empty

          in case of error an error

      4. In case section contains nested section check that sectionAllowed = true

        1. in case sectionAllowed = false return 422 ("Section {{section_code}}

          must

          can not contain

          emptyReason

          nested section")

  9. 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

  10. Check (47) count of section <= than value from - COMPOSITION_SECTION_COUNT_LIMIT

    • Return 422 ("Prohibited amount of composition section") in case of error

...

  1. Check (48) composition.section.title

    1. Check that composition.section.title is not empty.

    2. Also check value from COMPOSITION_SECTION_TITLE_MANUAL_FILL config (depends on composition.section.code)

      1. if config.value = "true" (or section with same code doesn't exist) - don’t validate composition.section.title

      2. else if value = "false"

        1. get display value from COMPOSITION_SECTION_CODES dictionary where key=composition.section.code

        2. check composition.section.title = display

    3. Return 422 ("Invalid title for composition.section") in case of error

  2. Check (48.1) that section code (composition.section.code) corresponds to appropriate dictionary - COMPOSITION_SECTION_CODES

    • Return 422 ("Section code value is not allowed in enum") in case of error

  3. Check (48.2) that section order by parameter (composition.section.orderby) corresponds to appropriate dictionary - COMPOSITION_SECTION_ORDERBY

    • Return 422 ("Section order by value is not allowed in enum") in case of error

  4. Check (48.3) that empty reason (composition.section.emptyreason) corresponds to appropriate config - COMPOSITION_SECTION_EMPTY_REASON. In case when composition.section.emptyreason is not empty

    • Return 422 ("Empty reason value is not allowed in enum") in case of error

  5. Check (50) that person from all records in composition.section.entry the same as composition.subject (or merged person in mpi.merged_person)

    • Return 422 ("Person from section.entry must be the same as composition.subject or composition.section.focus") in case of error

  6. Check (54) that author position from section.author based on config - COMPOSITION_SECTION_AUTHOR_POSITION for selected section.code

    • Return 422 ("Section author position does not allow to create such composition") in case of error

  7. Check (55) that author speciality from section.author based on config - COMPOSITION_SECTION_AUTHOR_SPECIALITY for selected section.code

    • Return 422 ("Section author speciality does not allow to create such composition") in case of error

  8. Check (55.1) that author main speciality (employee.accreditation.speciality_officio = true ) from section.authorbased on based on config - COMPOSITION_SECTION_AUTHOR_MAIN_SPECIALITY

    • Return 422 ("Section author main speciality does not allow to create such composition") in case of error

  9. Check (56) count of resources from composition.section.entry selected section.code - COMPOSITION_SECTION_SECTION_ENTRY_LIMIT

    • Return 422 ("Max count of resources in section.entry - <count>") in case of error

  10. Check (56.1) that the resource type of the resource in composition.section.entry is allowed by config COMPOSITION_SECTION_SECTION_ENTRY_RESOURCESfor this section.code and event.code

    • Return 422 ("Resource type is not allowed in this section for this event code") in case of error

...

  1. Check (60) that referenced diagnostic report (if entry has resource with this type) from composition.section.entry has status based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUS

    • Return 422 ("Invalid referenced diagnostic report status in section.entry") in case of error

  2. Check (61) that referenced diagnostic report (if entry has resource with this type) from composition.section.entry has code based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE where resource_type = "diagnostic report"

    • Return 422 ("Invalid code in referenced diagnostic report code in at section.entry") in case of error

  3. Check (62) that referenced diagnostic report (if entry has resource with this type) from composition.section.entry has category based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORY

    • Return 422 ("Invalid category in referenced diagnostic report category in at section.entry") in case of error

  4. Check (63) that different from sign composition date and referenced diagnostic report (if entry has resource with this type) effective_period.end in composition.section.entry between 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

  5. Check (63.1) that different from sign composition date and referenced diagnostic report (if entry has resource with this type) issued in composition.section.entry between 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

...

  1. Check (67.1) that referenced care plan (if entry has resource with this type) from composition.section.entry has category based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORY

    • Return 422 ("Invalid category in referenced care plan category in at section.entry") in case of error

  2. Check (68) that referenced care plan (if entry has resource with this type) from composition.section.entry has status based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUS

    • Return 422 ("Invalid referenced care plan status in section.entry") in case of error

  3. Check (70) that different from sign composition date and referenced care plan (if entry has resource with this type)period.start in composition.section.entry between 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

...

  1. Check (82) that referenced observation (if entry has resource with this type) from composition.section.entry has code (code.coding.code and code.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE where resource_type = "observation"

    • Return 422 ("Invalid code in referenced observation code in at section.entry") in case of error

  2. Check (83) that referenced observation (if entry has resource with this type) from composition.section.entry has status based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUS

    • Return 422 ("Invalid referenced observation status in section.entry") in case of error

  3. Check (84) that referenced observation (if entry has resource with this type) from composition.section.entry has category based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORY

    • Return 422 ("Invalid category in referenced observation category in at section.entry") in case of error

  4. Check (85) that different from sign composition date and referenced observation (if entry has resource with this type) issued in composition.section.entry between min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM where resource_type = "observation" and action = "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

  5. 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 filled effective_period.end in composition.section.entry calculate:
    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 where resource_type = "observation"
    if observation has filled effective_date_time in composition.section.entry calculate:
    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 where resource_type = "observation" and action = "effective"

    • Return 422 ("Difference between sign composition date and referenced observation date must be from <min> to <max>") in case of error

...

  1. Check (90) that referenced immunization (if entry has resource with this type) from composition.section.entry has explanation.reason_not_given (explanattion.reason_not_given.coding.code and explanation.reason_not_given.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_IMMUNIZATION_EXPLANATION_REASON_NOT_GIVEN

    • Return 422 ("Invalid referenced immunization explanation reason not given in section.entry") in case of error

  2. Check (91) that referenced immunization (if entry has resource with this type) from composition.section.entry has explanation.reason (explanattion.reason.coding.code and explanation.reason.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_IMMUNIZATION_EXPLANATION_REASON

    • Return 422 ("Invalid referenced immunization explanation reason in section.entry") in case of error

  3. Check (92) that referenced immunization (if entry has resource with this type) from composition.section.entry has status based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUS

    • Return 422 ("Invalid referenced immunization status in section.entry") in case of error

  4. Check (93) that referenced immunization (if entry has resource with this type) from composition.section.entry has vaccine_code (vaccine_code.coding.code and vaccine_code.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE where resource_type = "immunization"

    • Return 422 ("Invalid referenced immunization vaccine code in referenced immunization at section.entry") in case of error

  5. Check (94) that referenced immunization (if entry has resource with this type) from composition.section.entry has report_origin (report_origin.coding.code and report_origin.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_IMMUNIZATION_REPORT_ORIGIN

    • Return 422 ("Invalid referenced immunization report origin in section.entry") in case of error

  6. Check (95) that different from sign composition date and referenced immunization (if entry has resource with this type) date in composition.section.entry between min and max (depends on section code). Base on config - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_TERM where resource_type = "immunization" and action = "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

...

  1. Check (100) that referenced service request (if entry has resource with this type) from composition.section.entry has category (category.coding.code and category.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CATEGORY

    • Return 422 ("Invalid category in referenced service request category in at section.entry")

  2. Check (101) that referenced service request (if entry has resource with this type) from composition.section.entry has code.identifier (code.identifier.type.coding.code and code.identifier.type.coding.system) based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_CODE where resource_type = "service request"

    • Return 422 ("Invalid code identifier in referenced service request code identifier in at section.entry") in case of error

  3. Check (102) that referenced service request (if entry has resource with this type) from composition.section.entry has status based on dictionary which depends on section.code - COMPOSITION_SECTION_SECTION_ENTRY_RESOURCE_STATUS

    • Return 422 ("Invalid referenced service request status in section.entry") in case of error

  4. 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 filled occurrence_period.start in composition.section.entry calculate:
    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 where resource_type = "service request"
    if service request has filled occurrence_date_time in composition.section.entry calculate:
    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 where resource_type = "service request" and action = "occurrence"

    • Return 422 ("Difference between sign composition date and referenced service request date must be from <min> to <max>") in case of error

...

  1. Save signed content to media storage, in the bucket pointed in MEDIA_STORAGE_COMPOSITION_BUCKET chart parameter

  2. Set subject with hashed mpi identifier from URL

  3. Get encounter where id = Composition.encounter.identifier.value

    1. Set Composition.context_episode_id = encounter.episode

  4. Save data to compositions collection in DB according to composition data model

  5. Save link from media storage to the $.signed_content_links field in compositions collection

  6. Create job and return it’s id.

  7. 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

Response structure

https://ehealthmedicaleventsapi.docs.apiary.io/#reference/medical-events/composition/create-composition

...