Class: FHIR::DocumentReference

Inherits:
Model
  • Object
show all
Includes:
Hashable, Json, Xml
Defined in:
lib/fhir_models/fhir/resources/DocumentReference.rb

Defined Under Namespace

Classes: Content, Context, RelatesTo

Constant Summary collapse

SEARCH_PARAMS = 
["authenticator", "author", "class", "created", "custodian", "description", "encounter", "event", "facility", "format", "identifier", "indexed", "language", "location", "patient", "period", "related-id", "related-ref", "relatesto", "relation", "securitylabel", "setting", "status", "subject", "type"]
METADATA = 
{
  'id' => {'type'=>'id', 'path'=>'DocumentReference.id', 'min'=>0, 'max'=>1},
  'meta' => {'type'=>'Meta', 'path'=>'DocumentReference.meta', 'min'=>0, 'max'=>1},
  'implicitRules' => {'type'=>'uri', 'path'=>'DocumentReference.implicitRules', 'min'=>0, 'max'=>1},
  'language' => {'type'=>'code', 'path'=>'DocumentReference.language', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/languages'}},
  'text' => {'type'=>'Narrative', 'path'=>'DocumentReference.text', 'min'=>0, 'max'=>1},
  'contained' => {'type'=>'Resource', 'path'=>'DocumentReference.contained', 'min'=>0, 'max'=>Float::INFINITY},
  'extension' => {'type'=>'Extension', 'path'=>'DocumentReference.extension', 'min'=>0, 'max'=>Float::INFINITY},
  'modifierExtension' => {'type'=>'Extension', 'path'=>'DocumentReference.modifierExtension', 'min'=>0, 'max'=>Float::INFINITY},
  'masterIdentifier' => {'type'=>'Identifier', 'path'=>'DocumentReference.masterIdentifier', 'min'=>0, 'max'=>1},
  'identifier' => {'type'=>'Identifier', 'path'=>'DocumentReference.identifier', 'min'=>0, 'max'=>Float::INFINITY},
  'subject' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/Group', 'http://hl7.org/fhir/StructureDefinition/Device'], 'type'=>'Reference', 'path'=>'DocumentReference.subject', 'min'=>0, 'max'=>1},
  'type' => {'valid_codes'=>{'http://loinc.org'=>[]}, 'type'=>'CodeableConcept', 'path'=>'DocumentReference.type', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'preferred', 'uri'=>'http://hl7.org/fhir/ValueSet/c80-doc-typecodes'}},
  'class' => {'local_name'=>'local_class', 'valid_codes'=>{'http://loinc.org'=>['11369-6', '11485-0', '11486-8', '11488-4', '11506-3', '11543-6', '15508-5', '18726-0', '18761-7', '18842-5', '26436-6', '26441-6', '26442-4', '27895-2', '27896-0', '27897-8', '27898-6', '28570-0', '28619-5', '28634-4', '29749-9', '29750-7', '29751-5', '29752-3', '34109-9', '34117-2', '34121-4', '34122-2', '34133-9', '34140-4', '34748-4', '34775-7', '47039-3', '47042-7', '47045-0', '47046-8', '47049-2', '57017-6', '57016-8', '56445-0', '53576-5', '56447-6', '18748-4', '11504-8', '57133-1']}, 'type'=>'CodeableConcept', 'path'=>'DocumentReference.class', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'example', 'uri'=>'http://hl7.org/fhir/ValueSet/c80-doc-classcodes'}},
  'author' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/Device', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson'], 'type'=>'Reference', 'path'=>'DocumentReference.author', 'min'=>0, 'max'=>Float::INFINITY},
  'custodian' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'DocumentReference.custodian', 'min'=>0, 'max'=>1},
  'authenticator' => {'type_profiles'=>['http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/Organization'], 'type'=>'Reference', 'path'=>'DocumentReference.authenticator', 'min'=>0, 'max'=>1},
  'created' => {'type'=>'dateTime', 'path'=>'DocumentReference.created', 'min'=>0, 'max'=>1},
  'indexed' => {'type'=>'instant', 'path'=>'DocumentReference.indexed', 'min'=>1, 'max'=>1},
  'status' => {'valid_codes'=>{'http://hl7.org/fhir/document-reference-status'=>['current', 'superseded', 'entered-in-error', 'current', 'superseded', 'entered-in-error']}, 'type'=>'code', 'path'=>'DocumentReference.status', 'min'=>1, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/document-reference-status'}},
  'docStatus' => {'valid_codes'=>{'http://hl7.org/fhir/composition-status'=>['preliminary', 'final', 'amended', 'entered-in-error', 'preliminary', 'final', 'amended', 'entered-in-error']}, 'type'=>'CodeableConcept', 'path'=>'DocumentReference.docStatus', 'min'=>0, 'max'=>1, 'binding'=>{'strength'=>'required', 'uri'=>'http://hl7.org/fhir/ValueSet/composition-status'}},
  'relatesTo' => {'type'=>'DocumentReference::RelatesTo', 'path'=>'DocumentReference.relatesTo', 'min'=>0, 'max'=>Float::INFINITY},
  'description' => {'type'=>'string', 'path'=>'DocumentReference.description', 'min'=>0, 'max'=>1},
  'securityLabel' => {'valid_codes'=>{'http://hl7.org/fhir/v3/Confidentiality'=>['U', 'L', 'M', 'N', 'R', 'V'], 'http://hl7.org/fhir/v3/ActCode'=>['_InformationSensitivityPolicy', '_ActInformationSensitivityPolicy', 'ETH', 'GDIS', 'HIV', 'PSY', 'SOC', 'SCA', 'SDV', 'SEX', 'STD', 'TBOO', 'SICKLE', '_EntitySensitivityPolicyType', 'DEMO', 'DOB', 'GENDER', 'LIVARG', 'MARST', 'RACE', 'REL', '_RoleInformationSensitivityPolicy', 'B', 'EMPL', 'LOCIS', 'SSP', 'ADOL', 'CEL', 'DIA', 'DRGIS', 'EMP', 'PDS', 'PRS', 'COMPT', 'HRCOMPT', 'RESCOMPT', 'RMGTCOMPT', 'SecurityPolicy', 'ObligationPolicy', 'ANONY', 'AOD', 'AUDIT', 'AUDTR', 'CPLYCC', 'CPLYCD', 'CPLYJPP', 'CPLYOPP', 'CPLYOSP', 'CPLYPOL', 'DECLASSIFYLABEL', 'DEID', 'DELAU', 'DOWNGRDLABEL', 'DRIVLABEL', 'ENCRYPT', 'ENCRYPTR', 'ENCRYPTT', 'ENCRYPTU', 'HUAPRV', 'LABEL', 'MASK', 'MINEC', 'PERSISTLABEL', 'PRIVMARK', 'PSEUD', 'REDACT', 'UPGRDLABEL', 'RefrainPolicy', 'NOAUTH', 'NOCOLLECT', 'NODSCLCD', 'NODSCLCDS', 'NOINTEGRATE', 'NOLIST', 'NOMOU', 'NOORGPOL', 'NOPAT', 'NOPERSISTP', 'NORDSCLCD', 'NORDSCLCDS', 'NORDSCLW', 'NORELINK', 'NOREUSE', 'NOVIP', 'ORCON'], 'http://hl7.org/fhir/v3/ObservationValue'=>['_SECALTINTOBV', 'ABSTRED', 'AGGRED', 'ANONYED', 'MAPPED', 'MASKED', 'PSEUDED', 'REDACTED', 'SUBSETTED', 'SYNTAC', 'TRSLT', 'VERSIONED', '_SECDATINTOBV', 'CRYTOHASH', 'DIGSIG', '_SECINTCONOBV', 'HRELIABLE', 'RELIABLE', 'UNCERTREL', 'UNRELIABLE', '_SECINTPRVOBV', '_SECINTPRVABOBV', 'CLINAST', 'DEVAST', 'HCPAST', 'PACQAST', 'PATAST', 'PAYAST', 'PROAST', 'SDMAST', '_SECINTPRVRBOBV', 'CLINRPT', 'DEVRPT', 'HCPRPT', 'PACQRPT', 'PATRPT', 'PAYRPT', 'PRORPT', 'SDMRPT'], 'http://hl7.org/fhir/v3/ActReason'=>['PurposeOfUse', 'HMARKT', 'HOPERAT', 'DONAT', 'FRAUD', 'GOV', 'HACCRED', 'HCOMPL', 'HDECD', 'HDIRECT', 'HLEGAL', 'HOUTCOMS', 'HPRGRP', 'HQUALIMP', 'HSYSADMIN', 'MEMADMIN', 'PATADMIN', 'PATSFTY', 'PERFMSR', 'RECORDMGT', 'TRAIN', 'HPAYMT', 'CLMATTCH', 'COVAUTH', 'COVERAGE', 'ELIGDTRM', 'ELIGVER', 'ENROLLM', 'REMITADV', 'HRESCH', 'CLINTRCH', 'PATRQT', 'FAMRQT', 'PWATRNY', 'SUPNWK', 'PUBHLTH', 'DISASTER', 'THREAT', 'TREAT', 'CAREMGT', 'CLINTRL', 'ETREAT', 'POPHLTH'], 'http://hl7.org/fhir/v3/ActUSPrivacyLaw'=>['_ActUSPrivacyLaw', '42CFRPart2', 'CommonRule', 'HIPAANOPP', 'HIPAAPsyNotes', 'HIPAASelfPay', 'Title38Section7332']}, 'type'=>'CodeableConcept', 'path'=>'DocumentReference.securityLabel', 'min'=>0, 'max'=>Float::INFINITY, 'binding'=>{'strength'=>'extensible', 'uri'=>'http://hl7.org/fhir/ValueSet/security-labels'}},
  'content' => {'type'=>'DocumentReference::Content', 'path'=>'DocumentReference.content', 'min'=>1, 'max'=>Float::INFINITY},
  'context' => {'type'=>'DocumentReference::Context', 'path'=>'DocumentReference.context', 'min'=>0, 'max'=>1}
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Xml

from_xml, is_valid?, #to_xml, validate

Methods included from Json

from_json, #to_json

Methods included from Hashable

#from_hash, #to_hash

Methods inherited from Model

#attribute_mismatch, #compare_attribute, #equals?, #initialize, #is_valid?, #method_missing, #mismatch, #to_reference, #validate, #validate_profile

Constructor Details

This class inherits a constructor from FHIR::Model

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class FHIR::Model

Instance Attribute Details

#authenticator ⇒ Object

0-1 Reference(Practitioner|Organization)



141
142
143
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 141

def authenticator
  @authenticator
end

#author ⇒ Object

0-* [ Reference(Practitioner|Organization|Device|Patient|RelatedPerson) ]



139
140
141
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 139

def author
  @author
end

#contained ⇒ Object

0-* [ Resource ]



131
132
133
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 131

def contained
  @contained
end

#content ⇒ Object

1-* [ DocumentReference::Content ]



149
150
151
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 149

def content
  @content
end

#context ⇒ Object

0-1 DocumentReference::Context



150
151
152
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 150

def context
  @context
end

#created ⇒ Object

0-1 dateTime



142
143
144
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 142

def created
  @created
end

#custodian ⇒ Object

0-1 Reference(Organization)



140
141
142
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 140

def custodian
  @custodian
end

#description ⇒ Object

0-1 string



147
148
149
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 147

def description
  @description
end

#docStatus ⇒ Object

0-1 CodeableConcept



145
146
147
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 145

def docStatus
  @docStatus
end

#extension ⇒ Object

0-* [ Extension ]



132
133
134
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 132

def extension
  @extension
end

#id ⇒ Object

0-1 id



126
127
128
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 126

def id
  @id
end

#identifier ⇒ Object

0-* [ Identifier ]



135
136
137
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 135

def identifier
  @identifier
end

#implicitRules ⇒ Object

0-1 uri



128
129
130
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 128

def implicitRules
  @implicitRules
end

#indexed ⇒ Object

1-1 instant



143
144
145
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 143

def indexed
  @indexed
end

#language ⇒ Object

0-1 code



129
130
131
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 129

def language
  @language
end

#local_class ⇒ Object

0-1 CodeableConcept



138
139
140
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 138

def local_class
  @local_class
end

#masterIdentifier ⇒ Object

0-1 Identifier



134
135
136
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 134

def masterIdentifier
  @masterIdentifier
end

#meta ⇒ Object

0-1 Meta



127
128
129
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 127

def meta
  @meta
end

#modifierExtension ⇒ Object

0-* [ Extension ]



133
134
135
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 133

def modifierExtension
  @modifierExtension
end

#relatesTo ⇒ Object

0-* [ DocumentReference::RelatesTo ]



146
147
148
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 146

def relatesTo
  @relatesTo
end

#securityLabel ⇒ Object

0-* [ CodeableConcept ]



148
149
150
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 148

def securityLabel
  @securityLabel
end

#status ⇒ Object

1-1 code



144
145
146
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 144

def status
  @status
end

#subject ⇒ Object

0-1 Reference(Patient|Practitioner|Group|Device)



136
137
138
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 136

def subject
  @subject
end

#text ⇒ Object

0-1 Narrative



130
131
132
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 130

def text
  @text
end

#type ⇒ Object

1-1 CodeableConcept



137
138
139
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 137

def type
  @type
end

Instance Method Details

#resourceType ⇒ Object 



152
153
154
 
# File 'lib/fhir_models/fhir/resources/DocumentReference.rb', line 152

def resourceType
  'DocumentReference'
end