DSTU2 Ballot Source

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

5.1.3.2 StructureDefinition: USLabPatient

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/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.

5.1.3.2.1 Formal Views of Profile Content

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

This structure is derived from Patient.

Summary

Mandatory: 13 elements, Must-Support: 25 elements

Extensions

This structure refers to these extensions:

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1PatientPatient
... 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)
.... 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)
.... 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: USCountry (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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1PatientPatient
... 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: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..*CodeableConceptExtension
.... 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..1CodeableConceptExtension
.... 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 this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... 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
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: USLabNameUse (required)
.... 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)
... birthDate S Σ0..1dateThe date of birth for the individual
... deceased[x] ?! SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
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)
.... 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: USCountry (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 patient
Binding: MaritalStatus (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... 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
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ContactRelationship (required)
.... name 0..1HumanNameA name associated with the contact 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)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... animal ?! Σ0..1If this patient is an animal (non-human)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreed (example)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: AnimalGenderStatus (example)
... communication 0..*A list of Languages which may be used to communicate with the patient about his or her health
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link ?!0..*Link to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1PatientThe other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)
... active ?! Σ0..1booleanWhether this patient's record is in active use

todo

This structure is derived from Patient.

Summary

Mandatory: 13 elements, Must-Support: 25 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 1..1PatientPatient
... 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)
.... 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)
.... 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: USCountry (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..1PatientPatient
... 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: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..*CodeableConceptExtension
.... 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..1CodeableConceptExtension
.... 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 this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type 0..1CodeableConceptDescription of identifier
Binding: IdentifierType (extensible)
.... 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
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: USLabNameUse (required)
.... 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)
... birthDate S Σ0..1dateThe date of birth for the individual
... deceased[x] ?! SΣ0..1boolean, dateTimeIndicates if the individual is deceased or not
... address S Σ0..*AddressAddresses for the individual
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
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)
.... 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: USCountry (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 patient
Binding: MaritalStatus (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... 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
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... relationship 0..*CodeableConceptThe kind of relationship
Binding: ContactRelationship (required)
.... name 0..1HumanNameA name associated with the contact 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)
.... organization I0..1OrganizationOrganization that is associated with the contact
.... period 0..1PeriodThe period during which this contact person or organization is valid to be contacted relating to this patient
... animal ?! Σ0..1If this patient is an animal (non-human)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... species Σ1..1CodeableConceptE.g. Dog, Cow
Binding: AnimalSpecies (example)
.... breed Σ0..1CodeableConceptE.g. Poodle, Angus
Binding: AnimalBreed (example)
.... genderStatus Σ0..1CodeableConceptE.g. Neutered, Intact
Binding: AnimalGenderStatus (example)
... communication 0..*A list of Languages which may be used to communicate with the patient about his or her health
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... language 1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding: Language (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Organization, PractitionerPatient's nominated care provider
... managingOrganization Σ0..1OrganizationOrganization that is the custodian of the patient record
... link ?!0..*Link to another patient resource that concerns the same actual person
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... other ?!1..1PatientThe other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)
... active ?! Σ0..1booleanWhether this patient's record is in active use

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

5.1.3.2.2 Terminology Bindings

PathNameConformanceValueSet
Patient.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.identifier.typeIdentifierTypeextensibleIdentifier Type Codes
Patient.name.useUSLabNameUserequiredUSLabNameUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.stateUSPSStaterequiredUSPS Two Letter Alphabetic Codes
Patient.address.countryUSCountryextensiblehttp://www.iso.org/iso/country_codes.htm
Patient.maritalStatusMaritalStatusrequiredMarital Status Codes
Patient.contact.relationshipContactRelationshiprequiredPatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedexampleAnimalBreeds
Patient.animal.genderStatusAnimalGenderStatusexampleGenderStatus
Patient.communication.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

5.1.3.2.3 Constraints

IdPathNameDetails
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
.