Standard Health Record FHIR Implementation Guide

SHR ContraceptiveMethodRequested Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-sex-ContraceptiveMethodRequested

The contraceptive method(s) proposed, recommended or prescribed by a provider, after counseling and assessment.

This profile builds on Basic.

This profile was published on Tue Feb 27 00:00:00 EST 2018 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR ContraceptiveMethodRequested Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-sex-ContraceptiveMethodRequested"}]}
... shr-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... valueCodeableConcept Binding: SHR ContraceptiveMethodVS ValueSet (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... extension
..... extension
...... valueCodeableConcept Binding: SHR ContraceptiveMethodReasonVS ValueSet (required)
... shr-entity-MedicationOrCode-extension 1..1CodeableConcept, Reference(SHR Medication Profile)SHR MedicationOrCode Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-MedicationOrCode-extension
... shr-medication-Dosage-extension 0..1Reference(SHR Dosage Profile)SHR Dosage Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-Dosage-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR ContraceptiveMethodRequested Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR ContraceptiveMethodVS ValueSet (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... primitive-string-extension 0..1stringstring
URL: http://standardhealthrecord.org/fhir/StructureDefinition/primitive-string-extension
..... shr-core-CodeableConcept-extension 0..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension"
...... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR ContraceptiveMethodReasonVS ValueSet (required)
..... shr-base-Content-extension 0..1(Complex)SHR Content Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Content-extension
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension"
.... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension"
..... value[x] 1..1code, Coding, CodeableConceptValue of extension
Binding: RequestStatus (preferred)
.... shr-action-RequestIntent-extension 1..1codeSHR RequestIntent Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestIntent-extension
Binding: RequestIntent (required)
.... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
.... shr-action-ExpectedPerformerType-extension 0..1CodeableConceptSHR ExpectedPerformerType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformerType-extension
.... shr-action-ExpectedPerformer-extension 0..1(Complex)SHR ExpectedPerformer Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformer-extension
.... shr-action-ExpectedMethod-extension 0..1(Complex)SHR ExpectedMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedMethod-extension
.... shr-core-Priority-extension 0..1positiveInt, CodeableConceptSHR Priority Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension"
..... value[x] 1..1positiveInt, CodeableConceptValue of extension
Binding: RequestPriority (preferred)
.... shr-action-PerformerInstructions-extension 0..1stringSHR PerformerInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PerformerInstructions-extension
.... shr-action-PatientInstructions-extension 0..1stringSHR PatientInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PatientInstructions-extension
.... shr-action-CommunicationMethod-extension 0..1CodeableConceptSHR CommunicationMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-CommunicationMethod-extension
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension"
... shr-entity-MedicationOrCode-extension 1..1CodeableConcept, Reference(SHR Medication Profile)SHR MedicationOrCode Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-MedicationOrCode-extension
... shr-medication-Dosage-extension 0..1Reference(SHR Dosage Profile)SHR Dosage Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-Dosage-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-sex-ContraceptiveMethodRequested"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR ContraceptiveMethodRequested Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-sex-ContraceptiveMethodRequested"}]}
... shr-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... valueCodeableConcept Binding: SHR ContraceptiveMethodVS ValueSet (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... extension
..... extension
...... valueCodeableConcept Binding: SHR ContraceptiveMethodReasonVS ValueSet (required)
... shr-entity-MedicationOrCode-extension 1..1CodeableConcept, Reference(SHR Medication Profile)SHR MedicationOrCode Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-MedicationOrCode-extension
... shr-medication-Dosage-extension 0..1Reference(SHR Dosage Profile)SHR Dosage Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-Dosage-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR ContraceptiveMethodRequested Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-core-CodeableConcept-extension 1..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR ContraceptiveMethodVS ValueSet (required)
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-RequestedContext-extension 1..1(Complex)SHR RequestedContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... primitive-string-extension 0..1stringstring
URL: http://standardhealthrecord.org/fhir/StructureDefinition/primitive-string-extension
..... shr-core-CodeableConcept-extension 0..1CodeableConceptSHR CodeableConcept Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension
...... id 0..1stringxml:id (or equivalent in JSON)
...... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-CodeableConcept-extension"
...... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: SHR ContraceptiveMethodReasonVS ValueSet (required)
..... shr-base-Content-extension 0..1(Complex)SHR Content Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Content-extension
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension"
.... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension"
..... value[x] 1..1code, Coding, CodeableConceptValue of extension
Binding: RequestStatus (preferred)
.... shr-action-RequestIntent-extension 1..1codeSHR RequestIntent Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestIntent-extension
Binding: RequestIntent (required)
.... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
.... shr-action-ExpectedPerformerType-extension 0..1CodeableConceptSHR ExpectedPerformerType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformerType-extension
.... shr-action-ExpectedPerformer-extension 0..1(Complex)SHR ExpectedPerformer Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformer-extension
.... shr-action-ExpectedMethod-extension 0..1(Complex)SHR ExpectedMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedMethod-extension
.... shr-core-Priority-extension 0..1positiveInt, CodeableConceptSHR Priority Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension
..... id 0..1stringxml:id (or equivalent in JSON)
..... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Priority-extension"
..... value[x] 1..1positiveInt, CodeableConceptValue of extension
Binding: RequestPriority (preferred)
.... shr-action-PerformerInstructions-extension 0..1stringSHR PerformerInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PerformerInstructions-extension
.... shr-action-PatientInstructions-extension 0..1stringSHR PatientInstructions Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-PatientInstructions-extension
.... shr-action-CommunicationMethod-extension 0..1CodeableConceptSHR CommunicationMethod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-CommunicationMethod-extension
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-RequestedContext-extension"
... shr-entity-MedicationOrCode-extension 1..1CodeableConcept, Reference(SHR Medication Profile)SHR MedicationOrCode Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-MedicationOrCode-extension
... shr-medication-Dosage-extension 0..1Reference(SHR Dosage Profile)SHR Dosage Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-medication-Dosage-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-sex-ContraceptiveMethodRequested"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.extension.valueCodeableConceptSHR ContraceptiveMethodVS ValueSetrequiredSHR ContraceptiveMethodVS ValueSet
Basic.extension.extension.extension.valueCodeableConceptSHR ContraceptiveMethodReasonVS ValueSetrequiredSHR ContraceptiveMethodReasonVS ValueSet
Basic.extension.extension.value[x]RequestPrioritypreferredRequestPriority
Basic.extension.extension.value[x]RequestPrioritypreferredRequestPriority
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3BasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()