ARCHETYPE Contraceptive use summary (openEHR-EHR-EVALUATION.contraceptive_summary.v1)

ARCHETYPE IDopenEHR-EHR-EVALUATION.contraceptive_summary.v1
ConceptContraceptive use summary
DescriptionSummary and persistent information about the use of methods to prevent pregnancy.
UseUse to record the current status and episodic details about specific types of contraception used by an individual. This archetype is to be used to record information about both current and previous use of contraception. The specific scope of this archetype is on overall documentation about the use of all types of contraception, including episodes where more than one type of contraception may have been used simultaneously. The 'Per type' cluster of data elements allows for recording of specific details and episodes about each type of contraception used and can be repeated only once per type. In many situations the individual will use only one type of contraception at a time. However, if other types of contraception are used at the same time, the details will be recorded in another instance of the 'Per type' cluster. For each type of contraception the history of use over time can be captured using the repeatable 'Per episode' cluster. This cluster of data elements allows for a very detailed pattern of contraception use to be recorded, if necessary. Use to incorporate the narrative descriptions of contraceptive history within existing or legacy clinical systems into an archetyped format, using the 'Overall description' data element.
MisuseNot to be used to record detailed information about the medication prescription. Links from this archetype to the relevant INSTRUCTION.medication_order or ACTION.medication should be used to record the detail. Not to be used to record detailed information about the procedures performed, such as an IUD insertion or a vasectomy. Links from this archetype to the relevant ACTION.procedure should be used to record the detail.
PurposeTo record the current status and episodic details about specific types of contraception used by an individual.
References
Copyright© openEHR Foundation
AuthorsAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2009-06-21
Other Details LanguageAuthor name: Heather Leslie
Organisation: Atomica Informatics
Email: heather.leslie@atomicainformatics.com
Date originally authored: 2009-06-21
OtherDetails Language Independent{licence=This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/., custodian_organisation=openEHR Foundation, references=, current_contact=Heather Leslie, Atomica Informatics, original_namespace=org.openehr, original_publisher=openEHR Foundation, custodian_namespace=org.openehr, MD5-CAM-1.0.1=0ED359CA677901E7435742AC45DAF7CF, build_uid=f4c30a3d-7cf7-44de-945d-feff45de7b0a, revision=1.0.0}
Keywordscontraceptive, hormone, contraception, control, family planning, birth control measures
Lifecyclepublished
UIDc00537a4-52ae-4ac0-b27e-81659a213233
Language useden
Citeable Identifier1013.1.3273
Revision Number1.0.0
AllArchetype [runtimeNameConstraintForConceptName=null, archetypeConceptBinding=null, archetypeConceptDescription=Summary and persistent information about the use of methods to prevent pregnancy., archetypeConceptComment=null, otherContributors=Miguel Aguiar Netto, INLAGS, Brazil
Vebjørn Arntzen, Oslo University Hospital, Norway (openEHR Editor)
Silje Ljosland Bakke, Helse Vest IKT AS, Norway (openEHR Editor)
Terje Bektesevic Holmlund, UiT Norges arktiske universitet, Norway
SB Bhattacharyya, Sudisa Consultancy Services, India
Peter Fedorcsak, Oslo universitetssykehus, Norway
Mikkel Gaup Grønmo, Helse-Nord, FSE, Norway (openEHR Editor)
James Goddard, NHS Wales Informatics Service, United Kingdom
Heather Grain, Llewelyn Grain Informatics, Australia
Anne Grimstvedt Kvalvik, Haraldsplass Diakonale sykehus, Norway
Mikkel Johan Gaup Grønmo, Forvaltningssenter EPJ, Helse-Nord, Norway (openEHR Editor)
Anca Heyd, DIPS ASA, Norway
Evelyn Hovenga, EJSH Consulting, Australia
Nils Kolstrup, Skansen Legekontor og Nasjonalt Senter for samhandling og telemedisin, Norway
Jörgen Kuylenstierna, eWeave AB, Sweden
Liv Laugen, Oslo universitetssykehus, Norway (Nasjonal IKT redaktør)
Heather Leslie, Atomica Informatics, Australia (openEHR Editor)
Ian McNicoll, freshEHR Clinical Informatics, United Kingdom
Johannes Michael Strehle, Helse-Nord, Norway
Svenne Naumann, Finnmarkssykehuset, Norway
Bjørn Næss, DIPS ASA, Norway
sam philip, NHS Grampian, United Kingdom
Jussara Rotzsch, Hospital Alemão Oswaldo Cruz, Brazil
Danielle Santos Alves, Federal University of Pernambuco, Brazil
Line Silsand, Universitetssykehuset i Nord-Norge, Norway
Norwegian Review Summary, Nasjonal IKT HF, Norway
Nyree Taylor, Ocean Informatics, Australia
John Tore Valand, Helse Bergen, Norway (openEHR Editor)
Marit Alice Venheim, Helse Vest IKT, Norway (openEHR Editor), originalLanguage=en, translators=Norwegian Bokmål: Marit Alice Venheim, John Tore Valand, Helse Vest IKT, Helse Bergen, marit.alice.venheim@helse-vest-ikt.no, john.tore.valand@helse-bergen.no
, subjectOfData=unconstrained, archetypeTranslationTree=null, topLevelToAshis={credentials=[], details=[], source=[], description=[], protocol=[ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0073], code=at0073, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local content or to align with other reference models/formalisms., comment=For example: local information requirements or additional metadata to align with FHIR., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0022], code=at0022, itemType=ELEMENT, level=2, text=Last updated, description=The date this contraceptive use summary was last updated., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE_TIME, bindings=null, values=, extendedValues=null]], content=[], state=[], identities=[], events=[], relationships=[], data=[ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0089], code=at0089, itemType=ELEMENT, level=2, text=Overall status, description=Statement about regular use of any type of contraception., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=
  • Current user [Individual currently uses contraception.]
  • Not current user [Individual has previously used contraception but is not a current user.]
  • Never used [Individual has never used any type of contraception.]
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0043], code=at0043, itemType=ELEMENT, level=2, text=Overall description, description=Narrative summary about the individual's overall use of contraception., comment=Use this data element to record a narrative description where the structured data does not adequately reflect the use of contraception for this individual or to incorporate unstructured information from existing or legacy clinical systems into an archetyped format., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029], code=at0029, itemType=CLUSTER, level=2, text=Per type, description=Details about use of a specified type of contraception., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=1..*, cardinalityText=, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0151], code=at0151, itemType=ELEMENT, level=3, text=Type, description=The type of contraception used by the individual., comment=Coding the contraceptive type with a terminology is recommended, where possible., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Text
  •  Coded Text
    • Combination pill [A combination oral contraceptive pill containing both an oestrogen and progestin.]
    • Progestogen-only pill [Progestogen-only form of oral hormonal contraception.]
    • Combination skin patch [A combination skin patch containing both an oestrogen and progestin.]
    • Depot progestogen injection [Progestogen-only injectable of hormonal contraception.]
    • Hormone implant [Hormonal contraception inserted under the skin.]
    • Vaginal ring [Hormone impregnated ring inserted into the vagina.]
    • IUD with hormone [Device inserted into the uterus to prevent implantation.]
    • IUD without hormone [Device inserted into the uterus to prevent implantation.]
    • Female sterilisation [Procedure intended to permanently prevent pregnancy, usually by tubal ligitation.]
    • Male sterilisation [Procedure intended to permanently prevent pregnancy, usually by vasectomy.]
    • Diaphragm [A shallow, dome shaped barrier placed in the vagina to cover the cervix.]
    • Vaginal douching [Intravaginal cleansing with a liquid solution.]
    • Female condom [A barrier worn inside the vagina to physically block ejaculated sperm from entering the cervix.]
    • Male condom [A barrier covering the penis to physically block ejaculated sperm from entering the vagina.]
    • Withdrawal [Withdrawing the penis from the vagina and away from a woman's external genitals before ejaculation.]
    • Fertility awareness method [Cyclical use of abstinence or barrier methods during likely fertile periods.]
    • Abstinence [Avoidance of vaginal intercourse or intimate activities which may result in pregnancy.]
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0144], code=at0144, itemType=ELEMENT, level=3, text=Status, description=Statement about current use of the specified type of contraception., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_CODED_TEXT, bindings=null, values=
  • Current user [Individual is a current user of the specified type of contraception.]
  • Not current user [Individual has previously used the specified type of contraception but is not a current user.]
  • Never used [Individual has never used the specified type of contraception.]
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0053], code=at0053, itemType=ELEMENT, level=3, text=Description, description=Narrative summary about the use of the specified type of contraception., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0148], code=at0148, itemType=ELEMENT, level=3, text=Start date, description=Date when the individual first used the specified type of contraception., comment=Comment: Can be a partial date, for example, only a year., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE_TIME, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064], code=at0064, itemType=CLUSTER, level=3, text=Per episode, description=Details about contraceptive use during an identified period of time., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=1..*, cardinalityText=, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0081], code=at0081, itemType=ELEMENT, level=4, text=Episode label, description=Identification of an episode of contraception use - either as a number in a sequence and/or a named event., comment=For example: '2' as the second episode within a sequence of episodes; or 'Breastfeeding'., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CHOICE, bindings=null, values=Choice of:
  •  Count
    min: >=1

  •  Text
, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0023], code=at0023, itemType=ELEMENT, level=4, text=Specific name, description=Identification of the specific contraception used in this episode, by name., comment=For example: the brand name of the oral contraceptive pill. This data element is most likely redundant in the context of use of some contraceptives such as condoms where specification of the brand or type is usually not relevant., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0030], code=at0030, itemType=ELEMENT, level=4, text=Description, description=Narrative description about the overall use of contraception during this episode., comment=This data element may be used to describe the pattern of use, including regularity of use. For example, the oral contraceptive pill was missed frequently, condoms used occasionally or to describe minor side effects., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0168], code=at0168, itemType=ELEMENT, level=4, text=Clinical indication, description=Clinical reason for using the specified type of contraception during this episode., comment=For example: dysmenorrhoea; or irregular menses. Coding with an external terminology is preferred, where possible., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0025], code=at0025, itemType=ELEMENT, level=4, text=Goal, description=Intended outcome as a result of use of the specified contraception., comment=For example: pregnancy prevention, regular cycle or relief of pain. Coding with a terminology is recommended, where possible., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0013], code=at0013, itemType=ELEMENT, level=4, text=Episode start date, description=Date when this episode commenced., comment=Can be a partial date, for example, only a year., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0082], code=at0082, itemType=ELEMENT, level=4, text=Episode end date, description=Date when this episode ceased., comment=Can be a partial date, for example, only a year. This data field will be empty if the episode is current and ongoing., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0074], code=at0074, itemType=ELEMENT, level=4, text=Reason for cessation, description=Narrative description for the reason for stopping use of the specified type of contraception during this episode., comment=For example: Major side effects or the wish to become pregnant. Coding with a terminology is recommended, where possible., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0026], code=at0026, itemType=SLOT, level=4, text=Episode details, description=Additional structured details about the specified episode of contraception use., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0064]/items[at0087], code=at0087, itemType=ELEMENT, level=4, text=Episode comment, description=Additional narrative about the use of the specified contraception during the specified episode, not captured in other fields., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0149], code=at0149, itemType=ELEMENT, level=3, text=End date, description=Date when the individual last used the specified type of contraception., comment=Comment: Can be a partial date, for example, only a year., uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE_TIME, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0077], code=at0077, itemType=SLOT, level=3, text=Type details, description=Additional structured details about the specified type of contraception used., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0029]/items[at0069], code=at0069, itemType=ELEMENT, level=3, text=Comment, description=Additional narrative about use of the specified type of contraception, not captured in other fields., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0150], code=at0150, itemType=SLOT, level=2, text=Overall details, description=Additional structured details about the overall use of contraception., comment=null, uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/data[at0001]/items[at0019], code=at0019, itemType=ELEMENT, level=2, text=Overall comment, description=Additional narrative about the use of contraception that has not been captured in other fields., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_TEXT, bindings=null, values=, extendedValues=null]], contacts=[], capabilities=[], target=[], ism_transition=[], items=[], activities=[], context=[], provider=[], other_participations=[]}, topLevelItems={data=ResourceSimplifiedHierarchyItem [path=ROOT_/data[at0001], code=at0001, itemType=ITEM_TREE, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null], protocol=ResourceSimplifiedHierarchyItem [path=ROOT_/protocol[at0021], code=at0021, itemType=ITEM_TREE, level=0, text=null, description=null, comment=null, uncommonOntologyItems=null, occurencesFormal=1..1, occurencesText=Mandatory, cardinalityFormal=0..1, cardinalityText=optional, subCardinalityFormal=0..*, subCardinalityText=Minimum of 0 items, dataType=ITEM_TREE, bindings=null, values=null, extendedValues=null]}, addHierarchyItemsTo=protocol, currentHierarchyItemsForAdding=[ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0073], code=at0073, itemType=SLOT, level=2, text=Extension, description=Additional information required to capture local content or to align with other reference models/formalisms., comment=For example: local information requirements or additional metadata to align with FHIR., uncommonOntologyItems=null, occurencesFormal=0..*, occurencesText=Optional, repeating, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=CLUSTER, bindings=null, values=Include:
All not explicitly excluded archetypes, extendedValues=null], ResourceSimplifiedHierarchyItem [path=/protocol[at0021]/items[at0022], code=at0022, itemType=ELEMENT, level=2, text=Last updated, description=The date this contraceptive use summary was last updated., comment=null, uncommonOntologyItems=null, occurencesFormal=0..1, occurencesText=Optional, cardinalityFormal=null, cardinalityText=null, subCardinalityFormal=null, subCardinalityText=null, dataType=DV_DATE_TIME, bindings=null, values=, extendedValues=null]], minIndents={}, termBindingRetrievalErrorMessage=null]