STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

A.8.1.0 StructureDefinition: USLab-Patient

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/uslab-patient

Patient

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).

A.8.1.0.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: 8 elements (+9 nested mandatory elements)
Must-Support: 31 elements

Extensions

This structure refers to these extensions:

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientPatient
... identifier S1..1Identifier
.... use S1..1code
.... system S1..1uriOrganization or System URI
.... value S1..1stringPatient Identifier String
... name S1..1HumanName
.... use S1..1codeBinding: USLabNameUse (required)
.... family S1..1string
.... given S0..2string
.... suffix S0..1string
... gender S1..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... use S1..1code
.... line S0..2string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (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.
.... country S0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (required)
.... valueCodeableConcept S1..1CodeableConcept
..... coding S1..1Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
.... valueCodeableConcept S1..1CodeableConcept
..... coding S1..1Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientPatient
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (required)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-race"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: v3 Code System Race (required)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..1CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text ∑0..1stringPlain text representation of the concept
... us-core-ethnicity S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: v3 Code System Ethnicity (required)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..1CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text ∑0..1stringPlain text representation of the concept
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑1..1IdentifierAn identifier for this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriOrganization or System URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringPatient Identifier String
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?! ∑0..1booleanWhether this patient's record is in active use
... name S ∑1..1HumanNameA name associated with the patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: USLabNameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S ∑1..1stringFamily name (often called 'Surname')
.... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
.... prefix ∑0..*stringParts that come before the name
.... suffix S ∑0..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 ?! S∑1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑0..2stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (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 S ∑0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
.... 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: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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: PatientContactRelationship (extensible)
.... 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..1Reference(Organization)Organization 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..1BackboneElementThis patient is known to be 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: AnimalBreeds (example)
.... genderStatus ∑0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication 0..*BackboneElementA 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: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization ∑0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink 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..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

todo

This structure is derived from Patient.

Summary

Mandatory: 8 elements (+9 nested mandatory elements)
Must-Support: 31 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Patient.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientPatient
... identifier S1..1Identifier
.... use S1..1code
.... system S1..1uriOrganization or System URI
.... value S1..1stringPatient Identifier String
... name S1..1HumanName
.... use S1..1codeBinding: USLabNameUse (required)
.... family S1..1string
.... given S0..2string
.... suffix S0..1string
... gender S1..1code
... birthDate S0..1date
... deceased[x] S0..1boolean, dateTime
... address S0..*Address
.... use S1..1code
.... line S0..2string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (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.
.... country S0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
... us-core-race S0..1CodeableConceptA category of humans sharing history, origin or nationality
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (required)
.... valueCodeableConcept S1..1CodeableConcept
..... coding S1..1Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string
... us-core-ethnicity S0..1CodeableConceptA category of human sharing heritage
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
.... valueCodeableConcept S1..1CodeableConcept
..... coding S1..1Coding
...... system S1..1uri
...... code S1..1code
...... display S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..*PatientPatient
... 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: IETF BCP-47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... us-core-race S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-race
Binding: MU Race Value Set (required)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-race"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: v3 Code System Race (required)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..1CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text ∑0..1stringPlain text representation of the concept
... us-core-ethnicity S0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/us-core-ethnicity
Binding: Ethnicity group (required)
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
.... valueCodeableConcept S1..1CodeableConceptValue of extension
Binding: v3 Code System Ethnicity (required)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... coding S ∑1..1CodingCode defined by a terminology system
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system S ∑1..1uriIdentity of the terminology system
...... version ∑0..1stringVersion of the system - if relevant
...... code S ∑1..1codeSymbol in syntax defined by the system
...... display S ∑0..1stringRepresentation defined by the system
...... userSelected ∑0..1booleanIf this coding was chosen directly by the user
..... text ∑0..1stringPlain text representation of the concept
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S ∑1..1IdentifierAn identifier for this patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriOrganization or System URI
Example: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
.... value S ∑1..1stringPatient Identifier String
Example: 123456
.... period ∑0..1PeriodTime period when id is/was valid for use
.... assigner ∑0..1Reference(Organization)Organization that issued id (may be just text)
... active ?! ∑0..1booleanWhether this patient's record is in active use
... name S ∑1..1HumanNameA name associated with the patient
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S∑1..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: USLabNameUse (required)
.... text ∑0..1stringText representation of the full name
.... family S ∑1..1stringFamily name (often called 'Surname')
.... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
.... prefix ∑0..*stringParts that come before the name
.... suffix S ∑0..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 ?! S∑1..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑0..2stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (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 S ∑0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
.... 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: Marital Status Codes (required)
... multipleBirth[x] 0..1boolean, integerWhether patient is part of a multiple birth
... photo 0..*AttachmentImage of the patient
... contact I0..*BackboneElementA 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: PatientContactRelationship (extensible)
.... 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..1Reference(Organization)Organization 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..1BackboneElementThis patient is known to be 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: AnimalBreeds (example)
.... genderStatus ∑0..1CodeableConceptE.g. Neutered, Intact
Binding: GenderStatus (example)
... communication 0..*BackboneElementA 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: IETF BCP-47 (required)
.... preferred 0..1booleanLanguage preference indicator
... careProvider 0..*Reference(Organization | Practitioner)Patient's nominated primary care provider
... managingOrganization ∑0..1Reference(Organization)Organization that is the custodian of the patient record
... link ?!0..*BackboneElementLink 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..1Reference(Patient)The other patient resource that the link refers to
.... type ?!1..1codereplace | refer | seealso - type of link
Binding: LinkType (required)

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

A.8.1.0.2 Terminology Bindings

PathNameConformanceValueSet
Patient.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-race]]		MU Race Value SetrequiredMU Race Value Set
Patient.extension.valueCodeableConceptv3 Code System Ethnicityrequiredv3 Code System Ethnicity
Patient.extension
[UriType[http://hl7.org/fhir/StructureDefinition/us-core-ethnicity]]		Ethnicity grouprequiredEthnicity group
Patient.extension.valueCodeableConceptv3 Code System Ethnicityrequiredv3 Code System Ethnicity
Patient.identifier.useIdentifierUserequiredIdentifierUse
Patient.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Patient.name.useUSLabNameUserequiredUSLabNameUse
Patient.genderAdministrativeGenderrequiredAdministrativeGender
Patient.address.useAddressUserequiredAddressUse
Patient.address.typeAddressTyperequiredAddressType
Patient.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Patient.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Patient.maritalStatusMarital Status CodesrequiredMarital Status Codes
Patient.contact.relationshipPatientContactRelationshipextensiblePatientContactRelationship
Patient.contact.genderAdministrativeGenderrequiredAdministrativeGender
Patient.animal.speciesAnimalSpeciesexampleAnimalSpecies
Patient.animal.breedAnimalBreedsexampleAnimalBreeds
Patient.animal.genderStatusGenderStatusexampleGenderStatus
Patient.communication.language?extrequiredhttp://tools.ietf.org/html/bcp47
Patient.link.typeLinkTyperequiredLinkType

A.8.1.0.3 Constraints

IdPathDetailsRequirements
inv-1Patient.address.postalCode(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.contactSHALL 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
.