NCCN Templates® 1.0

StructureDefinition-regimen-entry-template

A regimen entry defines a single medication and its dosage instructions within a larger medication regimen.

A regimen entry template represents a single medication within an order template.

Formal Views of Profile Content

The official URL for this profile is: 

http://nccn.org/fhir/StructureDefinition/regimen-entry-template

This profile builds on ActivityDefinition.

This profile was published on Fri Apr 14 00:00:00 EDT 2017 as a draft by The National Comprehensive Cancer Network.

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*NCCN Order Template Profile
... id 1..1id
... meta 1..1Meta
.... id 0..0
.... versionId 0..0
.... lastUpdated 0..0
.... profile 1..1uriFixed Value: http://nccn.org/fhir/StructureDefinition/regimen-entry
.... security 0..0
.... tag 0..0
.... extension 0..0
... implicitRules 0..0
... language 0..0
... text 0..0
... contained 0..0
... url 0..0
... identifier 0..0
... version 0..0
... name 0..0
... title 0..0
... status 1..1code"active" if the template is currently published
... experimental 0..0
... date 0..0
... publisher 0..0
... description 0..0
... purpose 0..0
... usage 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... useContext 0..0
... jurisdiction 0..0
... topic 0..0
... contributor 0..0
... contact 0..0
... copyright 0..0
... relatedArtifact 0..0
... library 0..0
... kind 1..1codeFixed Value: MedicationRequest
... code 0..0
... timing[x] 0..0
... location 0..0
... participant 0..0
... productCodeableConcept 1..1CodeableConceptBinding: RxNorm Ingredients (required)
... quantity 0..0
... dosage 1..1Dosage
.... id 0..0
.... sequence 0..0
.... text 1..1string
.... additionalInstruction 0..0
.... patientInstructions 0..0
.... timing 0..1Timing
..... id 0..1string
..... event 0..0
..... repeat 0..1Element
...... boundsRange 0..1Range
...... count 0..1integer
...... countMax 0..1integer
...... duration 0..1decimal
...... durationMax 0..1decimal
...... durationUnit 0..1code
...... frequency 0..1integer
...... frequencyMax 0..1integer
...... period 0..1decimal
...... periodMax 0..1decimal
...... periodUnit 0..1code
...... dayOfWeek 0..0
...... timeOfDay 0..0
...... when 0..0
...... offset 0..0
..... code 0..0
..... daysOfCycle 0..*(Complex)Extension
URL: http://nccn.org/fhir/StructureDefinition/daysOfCycle
.... asNeeded[x] 0..0
.... site 0..0
.... route 1..1CodeableConcept
.... method 0..1CodeableConceptBinding: IV Administration Methods (required)
.... dose[x] 0..1Range, SimpleQuantity
.... maxDosePerPeriod 0..0
.... maxDosePerAdministration 0..1SimpleQuantity
.... maxDosePerLifetime 0..0
.... rate[x] 0..1Ratio, Range, SimpleQuantity
.... fullyStructured 1..1booleanFalse if there is custom text in the cycle definition
URL: http://nccn.org/fhir/StructureDefinition/fullyStructured
... bodySite 0..0
... transform 0..0
... dynamicValue 0..0
... extension 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*NCCN Order Template Profile
... id Σ1..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... profile Σ1..1uriProfiles this resource claims to conform to

Fixed Value: http://nccn.org/fhir/StructureDefinition/regimen-entry
... status ?!Σ1..1code"active" if the template is currently published
Binding: PublicationStatus (required)
... kind 1..1codeKind of resource
Binding: ResourceType (required)
Fixed Value: MedicationRequest
... productCodeableConcept 1..1CodeableConceptWhat's administered/supplied
Binding: RxNorm Ingredients (required)
... dosage 1..1DosageDetailed dosage instructions
.... fullyStructured I1..1booleanExtension
URL: http://nccn.org/fhir/StructureDefinition/fullyStructured
.... text Σ1..1stringFree text dosage instructions e.g. SIG
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
..... id 0..1stringxml:id (or equivalent in JSON)
..... daysOfCycle I0..*(Complex)Extension
URL: http://nccn.org/fhir/StructureDefinition/daysOfCycle
..... repeat ΣI0..1ElementWhen the event is to occur
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... boundsRange Σ0..1RangeLength/Range of lengths, or (Start and/or end) limits
...... count Σ0..1integerNumber of times to repeat
...... countMax Σ0..1integerMaximum number of times to repeat
...... duration Σ0..1decimalHow long when it happens
...... durationMax Σ0..1decimalHow long when it happens (Max)
...... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ0..1integerEvent occurs frequency times per period
...... frequencyMax Σ0..1integerEvent occurs up to frequencyMax times per period
...... period Σ0..1decimalEvent occurs frequency times per period
...... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
.... route Σ1..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (example)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: IV Administration Methods (required)
.... dose[x] Σ0..1Range, SimpleQuantityAmount of medication per dose
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... rate[x] Σ0..1Ratio, Range, SimpleQuantityAmount of medication per unit of time

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition 0..*NCCN Order Template Profile
... id 1..1id
... meta 1..1Meta
.... id 0..0
.... versionId 0..0
.... lastUpdated 0..0
.... profile 1..1uriFixed Value: http://nccn.org/fhir/StructureDefinition/regimen-entry
.... security 0..0
.... tag 0..0
.... extension 0..0
... implicitRules 0..0
... language 0..0
... text 0..0
... contained 0..0
... url 0..0
... identifier 0..0
... version 0..0
... name 0..0
... title 0..0
... status 1..1code"active" if the template is currently published
... experimental 0..0
... date 0..0
... publisher 0..0
... description 0..0
... purpose 0..0
... usage 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... useContext 0..0
... jurisdiction 0..0
... topic 0..0
... contributor 0..0
... contact 0..0
... copyright 0..0
... relatedArtifact 0..0
... library 0..0
... kind 1..1codeFixed Value: MedicationRequest
... code 0..0
... timing[x] 0..0
... location 0..0
... participant 0..0
... productCodeableConcept 1..1CodeableConceptBinding: RxNorm Ingredients (required)
... quantity 0..0
... dosage 1..1Dosage
.... id 0..0
.... sequence 0..0
.... text 1..1string
.... additionalInstruction 0..0
.... patientInstructions 0..0
.... timing 0..1Timing
..... id 0..1string
..... event 0..0
..... repeat 0..1Element
...... boundsRange 0..1Range
...... count 0..1integer
...... countMax 0..1integer
...... duration 0..1decimal
...... durationMax 0..1decimal
...... durationUnit 0..1code
...... frequency 0..1integer
...... frequencyMax 0..1integer
...... period 0..1decimal
...... periodMax 0..1decimal
...... periodUnit 0..1code
...... dayOfWeek 0..0
...... timeOfDay 0..0
...... when 0..0
...... offset 0..0
..... code 0..0
..... daysOfCycle 0..*(Complex)Extension
URL: http://nccn.org/fhir/StructureDefinition/daysOfCycle
.... asNeeded[x] 0..0
.... site 0..0
.... route 1..1CodeableConcept
.... method 0..1CodeableConceptBinding: IV Administration Methods (required)
.... dose[x] 0..1Range, SimpleQuantity
.... maxDosePerPeriod 0..0
.... maxDosePerAdministration 0..1SimpleQuantity
.... maxDosePerLifetime 0..0
.... rate[x] 0..1Ratio, Range, SimpleQuantity
.... fullyStructured 1..1booleanFalse if there is custom text in the cycle definition
URL: http://nccn.org/fhir/StructureDefinition/fullyStructured
... bodySite 0..0
... transform 0..0
... dynamicValue 0..0
... extension 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ActivityDefinition I0..*NCCN Order Template Profile
... id Σ1..1idLogical id of this artifact
... meta Σ1..1MetaMetadata about the resource
.... profile Σ1..1uriProfiles this resource claims to conform to

Fixed Value: http://nccn.org/fhir/StructureDefinition/regimen-entry
... status ?!Σ1..1code"active" if the template is currently published
Binding: PublicationStatus (required)
... kind 1..1codeKind of resource
Binding: ResourceType (required)
Fixed Value: MedicationRequest
... productCodeableConcept 1..1CodeableConceptWhat's administered/supplied
Binding: RxNorm Ingredients (required)
... dosage 1..1DosageDetailed dosage instructions
.... fullyStructured I1..1booleanExtension
URL: http://nccn.org/fhir/StructureDefinition/fullyStructured
.... text Σ1..1stringFree text dosage instructions e.g. SIG
.... patientInstruction Σ0..1stringPatient or consumer oriented instructions
.... timing Σ0..1TimingWhen medication should be administered
..... id 0..1stringxml:id (or equivalent in JSON)
..... daysOfCycle I0..*(Complex)Extension
URL: http://nccn.org/fhir/StructureDefinition/daysOfCycle
..... repeat ΣI0..1ElementWhen the event is to occur
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... boundsRange Σ0..1RangeLength/Range of lengths, or (Start and/or end) limits
...... count Σ0..1integerNumber of times to repeat
...... countMax Σ0..1integerMaximum number of times to repeat
...... duration Σ0..1decimalHow long when it happens
...... durationMax Σ0..1decimalHow long when it happens (Max)
...... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
...... frequency Σ0..1integerEvent occurs frequency times per period
...... frequencyMax Σ0..1integerEvent occurs up to frequencyMax times per period
...... period Σ0..1decimalEvent occurs frequency times per period
...... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required)
.... route Σ1..1CodeableConceptHow drug should enter body
Binding: SNOMED CT Route Codes (example)
.... method Σ0..1CodeableConceptTechnique for administering medication
Binding: IV Administration Methods (required)
.... dose[x] Σ0..1Range, SimpleQuantityAmount of medication per dose
.... maxDosePerAdministration Σ0..1SimpleQuantityUpper limit on medication per administration
.... rate[x] Σ0..1Ratio, Range, SimpleQuantityAmount of medication per unit of time

doco Documentation for this format

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