2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: USLabPatient

The official URL for this profile is: 

http://hl7.org/fhir/Profile/patient-uslab-uslabpatient

. Patient

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

unable to summarise extension (wrong count)

Formal Views of Profile Content

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

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... text S1..1
.... status S1..1codeFixed Value: generated
... identifier S1..1Identifier
.... use S1..1
.... system S1..1Organization or System URI
.... value S1..1Patient Identifier String
... name S1..1
.... use S1..1codeBinding: USLabNameUse (required, not extensible)
.... family S1..1
.... given S0..2
.... suffix S0..1
... gender S1..1
... birthDate S0..1
... deceased[x] S0..1
... address S0..*
.... use S1..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required, extensible)
.... postalCode S I0..1US Zip Codes
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1ISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
... us-core-race S0..*CodeableConceptA category of humans sharing history, origin or nationality
.... coding S1..1
..... code S1..1
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
.... coding S1..1
..... code S1..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..*CodeableConceptAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... us-core-ethnicity S0..1CodeableConceptAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S Σ1..1IdentifierAn identifier for the person as this patient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... system S1..1uriOrganization or System URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringPatient Identifier String
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S Σ1..1HumanNameA name associated with the patient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: USLabNameUse (required, not extensible)
.... text 0..1stringText representation of the full name
.... family S1..1stringFamily name (often called 'Surname')
.... given S0..2stringGiven names (not always 'first'). Includes middle names
.... prefix 0..*stringParts that come before the name
.... suffix S0..1stringParts that come after the name
.... period 0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
... gender S Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
... birthDate S Σ0..1dateThe date of birth for the individual
... birthTime Σ0..1timeThe time of birth for the individual
... deceased[x] M SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (required, extensible)
.... postalCode S I0..1stringUS Zip Codes
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S0..1stringISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus Σ0..1CodeableConceptMarital (civil) status of a person
Binding: MaritalStatus (preferred, extensible)
... multipleBirth[x] Σ0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the person
... contact I0..*A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ContactRelationship (preferred, extensible)
.... name 0..1HumanNameA name associated with the person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... animal M Σ0..1If this patient is an animal (non-human)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example, extensible)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreed (example, extensible)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: AnimalGenderStatus (example, extensible)
... communication 0..*CodeableConceptLanguages which may be used to communicate with the patient about his or her health
Binding: Language (required, not extensible)
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link M Σ0..*Link to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... other M Σ1..1PatientThe other patient resource that the link refers to
.... type M Σ1..1codereplace | refer | seealso - type of link
Binding: LinkType (required, not extensible)
... active M Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... text S1..1
.... status S1..1codeFixed Value: generated
... identifier S1..1Identifier
.... use S1..1
.... system S1..1Organization or System URI
.... value S1..1Patient Identifier String
... name S1..1
.... use S1..1codeBinding: USLabNameUse (required, not extensible)
.... family S1..1
.... given S0..2
.... suffix S0..1
... gender S1..1
... birthDate S0..1
... deceased[x] S0..1
... address S0..*
.... use S1..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required, extensible)
.... postalCode S I0..1US Zip Codes
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1ISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
... us-core-race S0..*CodeableConceptA category of humans sharing history, origin or nationality
.... coding S1..1
..... code S1..1
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
.... coding S1..1
..... code S1..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1Patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text S I1..1NarrativeText summary of the resource, for human interpretation
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... status S1..1codegenerated | extensions | additional
Binding: NarrativeStatus (required, not extensible)
Fixed Value: generated
.... div I1..1xhtmlLimited xhtml content
txt-2: The narrative SHALL have some non-whitespace content
txt-1: The narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
txt-3: The narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..*CodeableConceptAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... us-core-ethnicity S0..1CodeableConceptAdditional Content defined by implementations
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... url 1..1uriidentifies the meaning of the extension
.... value[x] 0..1*Value of extension
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S Σ1..1IdentifierAn identifier for the person as this patient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required, not extensible)
.... label 0..1stringDescription of identifier
.... system S1..1uriOrganization or System URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri
.... value S1..1stringPatient Identifier String
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S Σ1..1HumanNameA name associated with the patient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: USLabNameUse (required, not extensible)
.... text 0..1stringText representation of the full name
.... family S1..1stringFamily name (often called 'Surname')
.... given S0..2stringGiven names (not always 'first'). Includes middle names
.... prefix 0..*stringParts that come before the name
.... suffix S0..1stringParts that come after the name
.... period 0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the individual
... gender S Σ1..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
... birthDate S Σ0..1dateThe date of birth for the individual
... birthTime Σ0..1timeThe time of birth for the individual
... deceased[x] M SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use M S1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required, not extensible)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (required, extensible)
.... postalCode S I0..1stringUS Zip Codes
inv-1: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S0..1stringISO 3166 3 letter Country Code
Binding: USLabCountry (required, extensible)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus Σ0..1CodeableConceptMarital (civil) status of a person
Binding: MaritalStatus (preferred, extensible)
... multipleBirth[x] Σ0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the person
... contact I0..*A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ContactRelationship (preferred, extensible)
.... name 0..1HumanNameA name associated with the person
.... telecom 0..*ContactPointA contact detail for the person
.... address 0..1AddressAddress for the contact person
.... gender 0..1codemale | female | other | unknown
Binding: AdministrativeGender (required, not extensible)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this person or organization is valid to be contacted relating to this patient
... animal M Σ0..1If this patient is an animal (non-human)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example, extensible)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreed (example, extensible)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: AnimalGenderStatus (example, extensible)
... communication 0..*CodeableConceptLanguages which may be used to communicate with the patient about his or her health
Binding: Language (required, not extensible)
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link M Σ0..*Link to another patient resource that concerns the same actual person
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... other M Σ1..1PatientThe other patient resource that the link refers to
.... type M Σ1..1codereplace | refer | seealso - type of link
Binding: LinkType (required, not extensible)
... active M Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.text.statusNarrativeStatusrequiredNarrativeStatus
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.name.useUSLabNameUserequiredUSLabNameUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.stateUSPSStaterequired (extensible)USPS Two Letter Alphabetic Codes
Patient.address.countryUSLabCountryrequired (extensible)USLabCountry
Patient.maritalStatusMaritalStatuspreferred (extensible)Marital Status Codes
Patient.contact.relationshipContactRelationshippreferred (extensible)PatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexample (extensible)AnimalSpecies
Patient.animal.breedAnimalBreedexample (extensible)AnimalBreeds
Patient.animal.genderStatusAnimalGenderStatusexample (extensible)GenderStatus
Patient.communicationLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

Constraints

IdPathNameDetails
txt-2Patient.text.divThe narrative SHALL have some non-whitespace content
XPath: descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]
txt-1Patient.text.divThe narrative SHALL contain only the basic html formatting elements described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))])
txt-3Patient.text.divThe narrative SHALL contain only the basic html formatting attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes
XPath: not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])
inv-1Patient.address.postalCodeRegex for Zip(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
pat-1Patient.contactContactNeedsDetailsSHALL at least contain a contact's details or a reference to an organization
XPath: f:name or f:telecom or f:address or f:organization
.